lucenenet-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "michael herndon (JIRA)" <j...@apache.org>
Subject [Lucene.Net] [jira] [Updated] (LUCENENET-438) replace java doc notation with ms style xml comments notation.
Date Sat, 23 Jul 2011 19:37:09 GMT

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

michael herndon updated LUCENENET-438:
--------------------------------------

    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  

  was:
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.  


> 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.
For more information on JIRA, see: http://www.atlassian.com/software/jira

        

Mime
View raw message