0xCAB / idocit

Automatically exported from code.google.com/p/idocit
0 stars 0 forks source link

Existing Javadoc should be transfered to iDocIt! documentation #62

Closed GoogleCodeExporter closed 8 years ago

GoogleCodeExporter commented 8 years ago
If there are existing Javadoc comments in a Java interface or class they should 
be absorbt by iDocIt!. After conversion, the Javadoc can be edited in the 
iDocIt! editor.
If a converted documentation is not been edited it will not be changed by 
writing the documentation back to the source file. But if it was changed it is 
written in the iDocIt! format.

Original issue reported on code.google.com by dirk.mei...@gmail.com on 17 Aug 2011 at 6:58

GoogleCodeExporter commented 8 years ago

Original comment by dirk.mei...@gmail.com on 30 Aug 2011 at 1:58

GoogleCodeExporter commented 8 years ago
Now, existing Javadoc comments are converted to iDocIt! documentations. If they 
aren't changed in the iDocIt! editor they will be also unchanged in the source 
file. Additional Javadoc tags (all except @param, @return, @throws and the 
general description; e.g. @author, @see etc.) are kept. If the iDocIt! 
documentations are written into the source file, the additional tags are 
appended at the end of the generated Javadoc comment.

Original comment by dirk.mei...@gmail.com on 8 Sep 2011 at 2:02