lucenenet-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Shad Storhaug (JIRA)" <j...@apache.org>
Subject [jira] [Resolved] (LUCENENET-438) replace java doc notation with ms style xml comments notation.
Date Wed, 28 Jun 2017 22:50:00 GMT

     [ https://issues.apache.org/jira/browse/LUCENENET-438?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
]

Shad Storhaug resolved LUCENENET-438.
-------------------------------------
       Resolution: Fixed
    Fix Version/s: Lucene.Net 4.8.0

This is now completely fixed.

> 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,
>             Fix For: Lucene.Net 4.8.0
>
>
> 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 was sent by Atlassian JIRA
(v6.4.14#64029)

Mime
View raw message