aspose file tools*
The moose likes Java in General and the fly likes javadoc, doc-files, images are ignored Big Moose Saloon
  Search | Java FAQ | Recent Topics | Flagged Topics | Hot Topics | Zero Replies
Register / Login


Win a copy of Spring in Action this week in the Spring forum!
JavaRanch » Java Forums » Java » Java in General
Bookmark "javadoc, doc-files, images are ignored" Watch "javadoc, doc-files, images are ignored" New topic
Author

javadoc, doc-files, images are ignored

Sean Sullivan
Ranch Hand

Joined: Sep 09, 2001
Posts: 427
My environment is:
Windows XP Professional
Java 2 SDK version 1.4.2_02
Apache Maven 1.0-RC1
I am executing javadoc using Maven's javadoc report capability.
It appears that javadoc is ignoring the images that I placed in the doc-files directory.
This is my source tree:
C:\eclipse\workspace\smtphandlerProject\src\java\CVS
C:\eclipse\workspace\smtphandlerProject\src\java\smtphandler
C:\eclipse\workspace\smtphandlerProject\src\java\CVS\Entries
C:\eclipse\workspace\smtphandlerProject\src\java\CVS\Repository
C:\eclipse\workspace\smtphandlerProject\src\java\CVS\Root
C:\eclipse\workspace\smtphandlerProject\src\java\smtphandler\CVS
C:\eclipse\workspace\smtphandlerProject\src\java\smtphandler\CyclicBuffer.java
C:\eclipse\workspace\smtphandlerProject\src\java\smtphandler\doc-files
C:\eclipse\workspace\smtphandlerProject\src\java\smtphandler\SMTPHandler.java
C:\eclipse\workspace\smtphandlerProject\src\java\smtphandler\TriggeringRecordEvaluator.java
C:\eclipse\workspace\smtphandlerProject\src\java\smtphandler\CVS\Entries
C:\eclipse\workspace\smtphandlerProject\src\java\smtphandler\CVS\Repository
C:\eclipse\workspace\smtphandlerProject\src\java\smtphandler\CVS\Root
C:\eclipse\workspace\smtphandlerProject\src\java\smtphandler\doc-files\CVS
C:\eclipse\workspace\smtphandlerProject\src\java\smtphandler\doc-files\foo.gif
C:\eclipse\workspace\smtphandlerProject\src\java\smtphandler\doc-files\smtphandler-diagram.jpg
C:\eclipse\workspace\smtphandlerProject\src\java\smtphandler\doc-files\CVS\Entries
C:\eclipse\workspace\smtphandlerProject\src\java\smtphandler\doc-files\CVS\Repository
C:\eclipse\workspace\smtphandlerProject\src\java\smtphandler\doc-files\CVS\Root

This is the verbose output from Maven:
maven-javadoc-plugin:report:
[record] [DEBUG] setting a recorder for name C:\eclipse\workspace\smtphandlerProject/target/javadoc/report.txt
[javadoc] [DEBUG] fileset: Setup scanner in dir C:\eclipse\workspace\smtphandlerProject\src\java
with patternSet{ includes: [**/*.java] excludes: [] }
[javadoc] Generating Javadoc
[javadoc] [VERBOSE] Executing 'C:\j2sdk1.4.2_02\bin\javadoc.exe' with arguments:
'-use'
'-stylesheetfile'
'C:\Documents and Settings\Sean\.maven\plugins\maven-javadoc-plugin-1.3\plugin-resources\stylesheet.css'
'-d'
'C:\eclipse\workspace\smtphandlerProject\target\docs\apidocs'
'-windowtitle'
'smtphandler 0.5 API'
'-private'
'-doctitle'
'smtphandler 0.5 API'
'-bottom'
'Copyright � 2003-2004 smtphandler.sourceforge.net. All Rights Reserved.'
'-classpath'
'C:\javamail-1.3.1\lib\mailapi.jar;C:\eclipse\workspace\smtphandlerProject\target\classes'
'-version'
'-author'
'C:\eclipse\workspace\smtphandlerProject\src\java\smtphandler\CyclicBuffer.java'
'C:\eclipse\workspace\smtphandlerProject\src\java\smtphandler\SMTPHandler.java'
'C:\eclipse\workspace\smtphandlerProject\src\java\smtphandler\TriggeringRecordEvaluator.java'
The ' characters around the executable and arguments are
not part of the command.

[javadoc] Javadoc execution
[javadoc] [DEBUG] Execute:Java13CommandLauncher: Executing 'C:\j2sdk1.4.2_02\bin\javadoc.exe'
with arguments:
'-use'
'-stylesheetfile'
'C:\Documents and Settings\Sean\.maven\plugins\maven-javadoc-plugin-1.3\plugin-resources\stylesheet.css'
'-d'
'C:\eclipse\workspace\smtphandlerProject\target\docs\apidocs'
'-windowtitle'
'smtphandler 0.5 API'
'-private'
'-doctitle'
'smtphandler 0.5 API'
'-bottom'
'Copyright � 2003-2004 smtphandler.sourceforge.net. All Rights Reserved.'
'-classpath'
'C:\javamail-1.3.1\lib\mailapi.jar;C:\eclipse\workspace\smtphandlerProject\target\classes'
'-version'
'-author'
'C:\eclipse\workspace\smtphandlerProject\src\java\smtphandler\CyclicBuffer.java'
'C:\eclipse\workspace\smtphandlerProject\src\java\smtphandler\SMTPHandler.java'
'C:\eclipse\workspace\smtphandlerProject\src\java\smtphandler\TriggeringRecordEvaluator.java'
The ' characters around the executable and arguments are
not part of the command.

[javadoc] Loading source file C:\eclipse\workspace\smtphandlerProject\src\java\smtphandler\CyclicBuffer.java...
[javadoc] Loading source file C:\eclipse\workspace\smtphandlerProject\src\java\smtphandler\SMTPHandler.java...
[javadoc] Loading source file C:\eclipse\workspace\smtphandlerProject\src\java\smtphandler\TriggeringRecordEvaluator.java...
[javadoc] Constructing Javadoc information...
[javadoc] Standard Doclet version 1.4.2_02
[javadoc] Generating C:\eclipse\workspace\smtphandlerProject\target\docs\apidocs\constant-values.html...
[javadoc] Copying file C:\Documents and Settings\Sean\.maven\plugins\maven-javadoc-plugin-1.3\plugin-resources\stylesheet.css
to file C:\eclipse\workspace\smtphandlerProject\target\docs\apidocs\stylesheet.css...
[javadoc] Building tree for all the packages and classes...
[javadoc] [VERBOSE] Generating C:\eclipse\workspace\smtphandlerProject\target\docs\apidocs\smtphandler\class-use\CyclicBuffer.html...
[javadoc] [VERBOSE] Generating C:\eclipse\workspace\smtphandlerProject\target\docs\apidocs\smtphandler\class-use\SMTPHandler.html...
[javadoc] [VERBOSE] Generating C:\eclipse\workspace\smtphandlerProject\target\docs\apidocs\smtphandler\class-use\DefaultEvaluator.html...
[javadoc] [VERBOSE] Generating C:\eclipse\workspace\smtphandlerProject\target\docs\apidocs\smtphandler\class-use\TriggeringRecordEvaluator.html...
[javadoc] [VERBOSE] Generating C:\eclipse\workspace\smtphandlerProject\target\docs\apidocs\smtphandler\package-use.html...
[javadoc] Building index for all the packages and classes...
[javadoc] [VERBOSE] Generating C:\eclipse\workspace\smtphandlerProject\target\docs\apidocs\overview-tree.html...
[javadoc] Generating C:\eclipse\workspace\smtphandlerProject\target\docs\apidocs\index-all.html...
[javadoc] "Send an e-mail when a specific logging record occurs, typically
on
[javadoc] {@link java.util.logging.Level#WARNING WARNING}
[javadoc] C:\eclipse\workspace\smtphandlerProject\src\java\smtphandler\SMTPHandler.java:93:
warning - The first sentence is interpreted to be:
[javadoc] or {@link java.util.logging.Level#SEVERE SEVERE}
[javadoc]
[javadoc] "
[javadoc] This sentence is different from what will be interpreted as the
first sentence in the
[javadoc] next major release (when that interpretation will be internationalized),
which is:
[javadoc] "Send an e-mail when a specific logging record occurs, typically
on
[javadoc] {@link java.util.logging.Level#WARNING WARNING}
[javadoc] or {@link java.util.logging.Level#SEVERE SEVERE}
[javadoc]
[javadoc] <p>The number of {@link LogRecord} objects delivered in this e-mail
depend on
[javadoc] the value of <b>bufferSize</b> option. "
[javadoc] To avoid this note, change the doc comment to make this a proper
first sentence, then
[javadoc] use -breakiterator from that point forward, which will output
this new sentence.
[javadoc] [VERBOSE] Generating C:\eclipse\workspace\smtphandlerProject\target\docs\apidocs\deprecated-list.html...
[javadoc] Building index for all classes...
[javadoc] [VERBOSE] Generating C:\eclipse\workspace\smtphandlerProject\target\docs\apidocs\allclasses-frame.html...
[javadoc] [VERBOSE] Generating C:\eclipse\workspace\smtphandlerProject\target\docs\apidocs\allclasses-noframe.html...
[javadoc] [VERBOSE] Generating C:\eclipse\workspace\smtphandlerProject\target\docs\apidocs\index.html...
[javadoc] [VERBOSE] Generating C:\eclipse\workspace\smtphandlerProject\target\docs\apidocs\packages.html...
[javadoc] [VERBOSE] Generating C:\eclipse\workspace\smtphandlerProject\target\docs\apidocs\smtphandler\package-frame.html...
[javadoc] C:\eclipse\workspace\smtphandlerProject\src\java\smtphandler\SMTPHandler.java:93:
warning - The first sentence is interpreted to be:
[javadoc] Generating C:\eclipse\workspace\smtphandlerProject\target\docs\apidocs\smtphandler\package-summary.html...
[javadoc] "Send an e-mail when a specific logging record occurs, typically
on
[javadoc] {@link java.util.logging.Level#WARNING WARNING}
[javadoc] or {@link java.util.logging.Level#SEVERE SEVERE}
[javadoc]
[javadoc] "
[javadoc] This sentence is different from what would be generated using
-breakiterator:
[javadoc] "Send an e-mail when a specific logging record occurs, typically
on
[javadoc] {@link java.util.logging.Level#WARNING WARNING}
[javadoc] or {@link java.util.logging.Level#SEVERE SEVERE}
[javadoc]
[javadoc] <p>The number of {@link LogRecord} objects delivered in this e-mail
depend on
[javadoc] the value of <b>bufferSize</b> option. "
[javadoc] [VERBOSE] Generating C:\eclipse\workspace\smtphandlerProject\target\docs\apidocs\smtphandler\package-tree.html...
[javadoc] [VERBOSE] Generating C:\eclipse\workspace\smtphandlerProject\target\docs\apidocs\smtphandler\CyclicBuffer.html...
[javadoc] [VERBOSE] Generating C:\eclipse\workspace\smtphandlerProject\target\docs\apidocs\smtphandler\DefaultEvaluator.html...
[javadoc] [VERBOSE] Generating C:\eclipse\workspace\smtphandlerProject\target\docs\apidocs\smtphandler\SMTPHandler.html...
[javadoc] [VERBOSE] Generating C:\eclipse\workspace\smtphandlerProject\target\docs\apidocs\smtphandler\TriggeringRecordEvaluator.html...
[javadoc] [VERBOSE] Generating C:\eclipse\workspace\smtphandlerProject\target\docs\apidocs\serialized-form.html...
[javadoc] [VERBOSE] Generating C:\eclipse\workspace\smtphandlerProject\target\docs\apidocs\package-list...
[javadoc] Generating C:\eclipse\workspace\smtphandlerProject\target\docs\apidocs\help-doc.html...
[javadoc] 2 warnings
[record] [DEBUG] setting a recorder for name C:\eclipse\workspace\smtphandlerProject/target/javadoc/report.txt

As you can see, javadoc does NOT copy the image files from the doc-files
directory.
Why is this happening?
walter wang
Ranch Hand

Joined: Jun 02, 2001
Posts: 154
you have to copy it manually


public class Walter { public boolean is_Working_Now (boolean is_boss_Coming) { return is_boss_Coming; }
 
I agree. Here's the link: http://aspose.com/file-tools
 
subject: javadoc, doc-files, images are ignored