[LUCENENET-438] replace java doc notation with ms style xml comments notation.

• Type: Improvement
• Status: Resolved
• Priority: Major
• Resolution: Fixed
• Affects Version/s: Lucene.Net 2.9.4g
• Fix Version/s: Lucene.Net 4.8.0
• Component/s: Lucene.Net Contrib, Lucene.Net Core
• Labels: documentation,

Environment

all

• Assignee: Unassigned
• Reporter: michael herndon
• Created: 22/Jul/11 16:59
• Updated: 28/Jun/17 22:49
• Resolved: 28/Jun/17 22:49

Description

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