Javadoc warning in the build status' log

Project:JNode Builder
Component:Documentation
Category:bug report
Priority:minor
Assigned:Unassigned
Status:closed
Description

The build status log shows this message in the javadoc-mmtk target :

[javadoc] /home/jnode/robot/svnwork/jnode/core/src/mmtk-vm/org/jnode/vm/
memmgr/mmtk/BaseMmtkHeapManager.java:181: warning - Tag @see: can't find
dumpStatistics(java.io.PrintStream) in org.jnode.vm.memmgr.VmHeapManager

Indeed, line 179 shows :

@see org.jnode.vm.memmgr.VmHeapManager#dumpStatistics(java.io.PrintStream)

... whereas line 336 of this newer (?) code shows a different signature :

public abstract void dumpStatistics(PrintWriter out);

#1

Submitted by Stephen Crawley on Sat, 03/21/2009 - 01:44.
Status:active» fixed

I've removed the pointless javadoc comment that caused this ... and others like it. Marking as 'fixed'.

#2

Submitted by brihaye on Sat, 03/21/2009 - 07:49.
Status:fixed» active

The new log shows many new issues in this area :

[javadoc] /home/jnode/robot/svnwork/jnode/core/src/core/org/jnode/
    plugin/PluginDescriptor.java:88: warning - @return tag has no arguments.

and so on for hundreds of lines.

#3

Submitted by Stephen Crawley on Sat, 03/21/2009 - 08:08.

Yea, we know. But these are not new errors. They have always been there ... if you run './build.sh javadocs'.

BTW, I'm going edit your reply to make it more legible and to delete some of the log. (We really don't need all of that stuff in a comment.)

#4

Submitted by Stephen Crawley on Tue, 03/24/2009 - 02:55.

I've fixed over half of the warnings ... just 301 'warnings' remain + 32 'errors', according to the log.

#5

Submitted by brihaye on Tue, 03/24/2009 - 18:54.

Nice effort Eye-wink Thank you.

Don't we need a few classes from OpenJDK ? Namely :
PlainDatagramSocketImpl
PlainSocketImpl
UNIXProcess

Also, what is the status of NanoXML's javadocs ?

#6

Submitted by Stephen Crawley on Tue, 03/24/2009 - 21:33.

Re: missing(?) OpenJDK classes. I'm assuming that the relevant classes will appear as Levente completes the integration.

Re: NanoXML's javadocs. I fixed them last night. It looks like the problems (and numerous other inconsistencies) happened because someone changed the APIs to use generics and modern collection types without changing the (well written) javadocs.

#7

Submitted by Stephen Crawley on Thu, 03/26/2009 - 13:48.
Status:active» postponed

I've fixed the last of the warnings. I'm putting the issue into pending to wait for the root cause of the errors to resolve itself - see above.

#8

Submitted by brihaye on Mon, 04/13/2009 - 07:37.

New messages like :


[javadoc] /home/jnode/robot/svnwork/jnode/core/src/core/org/jnode/naming/DefaultNameSpace.java:32: package org.jnode.annotation does not exist
[javadoc] import org.jnode.annotation.PrivilegedActionPragma;

Possibly related to revisions around 5226, especially :

trunk/core/src/classlib/org/jnode/annotation/

(Copied from trunk/core/src/core/org/jnode/vm/annotation, r5222)

Bad build path ?

#9

Submitted by Stephen Crawley on Mon, 04/13/2009 - 11:04.
Status:postponed» fixed

Fixed latest breakage.

#10

Submitted by Peter on Mon, 04/27/2009 - 18:57.
Status:fixed» closed