lucene-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Doron Cohen (JIRA)" <j...@apache.org>
Subject [jira] Updated: (LUCENE-875) javadocs creation has too many warnings/errors
Date Thu, 03 May 2007 23:25:15 GMT

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

Doron Cohen updated LUCENE-875:
-------------------------------

    Attachment: 875_javacc_patch.txt

Attached patch fixes all javadocs warnings and errors when using javadocs 1.4.2.

(*) javadocs with jdk 5 - current build.xml creates javadocs also for contrib/gdata only 
     under jdk 5. To fix the javadocs some jars had to be added to the javadocs classpath.

     But for gdata, even after adding the required jars there remained lots of errors that
I 
     did not want to handle here. So I commented out the addition of gdata jars, and focused

     in running javadocs with jdk 1.4.2.

(*) Some of the warning had to do with peculiarities of javadocs, In one case I replaced '?'

     with  '&#63;' - wasn't too happy with this, but it seemed nice at that particular
code 
     to have the '?' at the middle of a summary line, which was causing the warning. (in 
     other places I changed the wording so that '?' was o more in the summary line).

(*) This is quite a technical fix - only javadoc comments where modified (and build.xml),
so unless 
     there are objections I intend to commit it pretty soon.

> javadocs creation has too many warnings/errors
> ----------------------------------------------
>
>                 Key: LUCENE-875
>                 URL: https://issues.apache.org/jira/browse/LUCENE-875
>             Project: Lucene - Java
>          Issue Type: Task
>          Components: Javadocs
>    Affects Versions: 2.2
>            Reporter: Doron Cohen
>         Assigned To: Doron Cohen
>            Priority: Minor
>             Fix For: 2.2
>
>         Attachments: 875_javacc_patch.txt
>
>
> Currently running 'ant javadocs' creates so many warnings that you have to grep the output
to verify that new code did not add more.
> While most current errors might be minor, they might hide a few serious ones that we
will never know abut until someone complains. 
> Best if we fix all of them and keep it always clean...

-- 
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