lucene-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Tomer Gabel (JIRA)" <j...@apache.org>
Subject [jira] Commented: (LUCENE-1670) Cosmetic JavaDoc updates
Date Mon, 01 Jun 2009 07:10:08 GMT

    [ https://issues.apache.org/jira/browse/LUCENE-1670?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12714998#action_12714998
] 

Tomer Gabel commented on LUCENE-1670:
-------------------------------------

Alright, I'll attach a new patch in a couple of minutes that has the following improvements:
* LogMergePolicy: You are correct. I removed the links, as well as tried rewriting the paragraph
to be a little clearer.
* MergePolicy: This is not a problem; it does not appear in the API, but it's still linked
(hence refactoring tools such as Eclipse will update the link value as well as the class name),
and it shows in monospaced font as you'd expect with <code>.
* IndexWriter: Re (3), the extra token is the apparent text for the link (in this case, it
"hides" the parameters). I merely "translated" from the previous anchor tag to links.
* IndexWriter: Fixed a few typoes
* IndexWriter: Reverted the mergePolicy link change
* IndexWriter: Fixed missing IndexSearcher import for link



> Cosmetic JavaDoc updates
> ------------------------
>
>                 Key: LUCENE-1670
>                 URL: https://issues.apache.org/jira/browse/LUCENE-1670
>             Project: Lucene - Java
>          Issue Type: Improvement
>          Components: Javadocs
>    Affects Versions: 2.4.2
>         Environment: Lucene SVN (diff from r780545)
>            Reporter: Tomer Gabel
>            Priority: Trivial
>             Fix For: 2.4.2
>
>
> I've taken the liberty of making a few cosmetic updates to various JavaDocs:
> * MergePolicy (minor cosmetic change)
> * LogMergePolicy (minor cosmetic change)
> * IndexWriter (major cleanup in class description, changed anchors to JavaDoc links [now
works in Eclipse], no content change)
> Attached diff from SVN r780545.
> I would appreciate if whomever goes over this can let me know if my issue parameter choices
were correct (yeah, blame my OCD), and if there's a more practical/convenient way to send
these in, please let me know :-)

-- 
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.


---------------------------------------------------------------------
To unsubscribe, e-mail: java-dev-unsubscribe@lucene.apache.org
For additional commands, e-mail: java-dev-help@lucene.apache.org


Mime
View raw message