[
https://issues.apache.org/jira/browse/LUCENENET-438?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13293983#comment-13293983
]
Itamar Syn-Hershko commented on LUCENENET-438:
----------------------------------------------
This should be made by a tool, really
> 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
> 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
