Would it be possible (if it isn't already) to add a feature to correct existing javadoc. For example, if I have
"Foo does X Y and Z
@returns a new foo"
it would be good to keep the existing javadoc but correct the returns tag to return.
I guess thats true re mapping. However under JDK 8, invalid tags (e.g. @myreturns ) will cause the javadoc to fail. Could we search the '@...' tags and if one is found that is not in the valid list :
Disable it (remove the '@' (and leave a comment? ) ? )
Remove it
etc?
If you would like to refer to this comment somewhere else in this project, copy and paste the following link:
This would require some kind of mapping for JAutodoc, in order to know what should be corrected.
But I think, if its a general typo in your code, it is easier to do a search and replace. If not, its easy to correct it manually.
Can you agree to this?
I guess thats true re mapping. However under JDK 8, invalid tags (e.g. @myreturns ) will cause the javadoc to fail. Could we search the '@...' tags and if one is found that is not in the valid list :
Sorry, but I won't implement this. I don't see a good solution in JAutodoc, that's better than a search and replace.
I guess you already know this, but the best option for me would be to disable this "great" new feature in JDK 8
-Xdoclint:none
when generating Javadoc. Here you can find more details.