jankrause / idocit

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

SimpleJavadoc deletes documentations without thematic role #110

Closed GoogleCodeExporter closed 9 years ago

GoogleCodeExporter commented 9 years ago
What steps will reproduce the problem?
1. Create a Java interface, add a public method with at least one parameter, a 
return type or throws.
2. Create the default Javadoc comment. 
3. Write something as general description of the method and something to the 
@param and/or @return and/or @throws.

Example:
/**
 * My operation.
 * @param str My incoming string.
 * @return A new string.
 */
public String foo(String str);

4. Save the changes and open the interface with iDocIt!

What is the expected output? What do you see instead?
The existing documentations should be converted to iDocIt! Documentation 
objects and shown in the iDocIt! editor. But only the documentation "My 
operation." with the thematic role "ACTION" was converted and is shown in the 
editor. The other both documentations were ignored. Now, if you make a change 
and press save, both ignored documentations "My incoming string." and "A new 
string." are deleted in the source file.

Please use labels and text to provide additional information.
This happens, because the SimpleJavadoc handles the methods general description 
always by default as ACTION. Therefore, a missing ACTION role is added. Both 
other documentations have no role, therefore they are ignored. But as we have 
already one converted documentation, the converting method for converting 
Javadoc to iDocIt! documentation is not invoked.

This will happen always if at least one Javadoc tag has a thematic role or 
something is written for the general description. Then other documentations 
without thematic roles are ignored and by saving changed they will be deleted.

Original issue reported on code.google.com by dirk.mei...@gmail.com on 19 Jul 2012 at 7:46

GoogleCodeExporter commented 9 years ago
This issue was closed by revision r676.

Original comment by dirk.mei...@gmail.com on 25 Jul 2012 at 11:47