[
https://issues.apache.org/jira/browse/LUCENENET-438?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13144920#comment-13144920
]
Christopher Currens commented on LUCENENET-438:
-----------------------------------------------
This is mostly done. There are few if any java doc style comments in the core
and contrib (test source files were not modified). Some java style docs were
left in, but could easily be removed, specifically "@deprecated", "@since" and
"@author", maybe a few others.
The only things that would be left to do on an as needed basis, would be to
convert the multi-line xml comment format (/**) to the single line (///) format
as well as some general readability formatting. Either comment style will
produce documentation, but we use the single-line format nearly everywhere else
and it would be better to be consistent in our code.
> replace java doc notation with ms style xml comments notation.
> ----------------------------------------------------------------
>
> Key: LUCENENET-438
> URL: https://issues.apache.org/jira/browse/LUCENENET-438
> Project: Lucene.Net
> Issue Type: Improvement
> Components: Lucene.Net Contrib, Lucene.Net Core
> Affects Versions: Lucene.Net 2.9.4g
> Environment: all
> Reporter: michael herndon
> Assignee: Christopher Currens
> Labels: documentation,
>
> The are a ton of java doc style notations inside the xml code comments, i.e.
> {@link #IncrementToken}
> These need to use the ms xml code comment style if there is an existing
> equivalent. I'm not assigning this one. If you come across this on code you
> are working on, please take an extra few minutes to fix up the comments.
> If you need help, grab me on #lucene.net on irc or michaelherndon on skype.
> Just let me know who you are and what help you need.
> A guide for code documentation, it includes a table that shows JavaDoc and
> XML doc comment equivalents:
> https://cwiki.apache.org/confluence/display/LUCENENET/Documenting+Lucene.Net
--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators:
https://issues.apache.org/jira/secure/ContactAdministrators!default.jspa
For more information on JIRA, see: http://www.atlassian.com/software/jira
