[
https://issues.apache.org/jira/browse/LUCENE-1670?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12715047#action_12715047
]
Shai Erera commented on LUCENE-1670:
------------------------------------
Ok I checked and if you reference an item which is not generated in the
Javadocs, it appears in monospace, with no link. So I guess referencing
SegmentInfo is fine. Just as a FYI, not everybody use Eclipse, and Eclipse (I
think since 3.4) has the ability to update String references to class names you
refactor.
This look good now. Unfortunately, I'm not a committer so I cannot take this
issue any further :). Hope my review will help the committer that will choose
to commit it.
> 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
>
> Attachments: lucene_1670.patch
>
>
> 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: [email protected]
For additional commands, e-mail: [email protected]
