• Status: Solved
  • Priority: Medium
  • Security: Public
  • Views: 207
  • Last Modified:

Problem using Doc Check Doclet

I am trying to use Doc Check Doclet to generate a list of missing comments.
my package structure is something like

com\pack1\pack2
com\pack1\pack2\pack3
com\pack1\pack2\pack4
com\pack1\pack2\pack5

com\pack1\pack2\pack3\pack6
com\pack1\pack2\pack3\pack7

com\pack1\pack2\pack3\pack6\pack8

.... so on


i am trying to use the following command from prompt.

E:\>javadoc -doclet com.sun.tools.doclets.doccheck.DocCheck com  -subpackages co
m.pack1.pack2  -d test

But it gives me follwoing warning

Loading source files for package com...
javadoc: warning - No source files for package com
Constructing Javadoc information...
javadoc: warning - No source files for package com

How do i correct this.



0
thomas908
Asked:
thomas908
  • 9
  • 6
  • 5
2 Solutions
 
objectsCommented:
try using the -sourcepath option to specify source location(s)
0
 
thomas908Author Commented:
done this. still no success

E:\>javadoc -doclet com.sun.tools.doclets.doccheck.DocCheck com -sourcepath "e:\
 com" -subpackages com.dassault.mt.main  -d test
0
 
objectsCommented:
where are the sources its not finding?
0
Free Tool: Site Down Detector

Helpful to verify reports of your own downtime, or to double check a downed website you are trying to access.

One of a set of tools we are providing to everyone as a way of saying thank you for being a part of the community.

 
thomas908Author Commented:
in e:\  drive
in directory structure

e:\com\pack1 ... etc

0
 
objectsCommented:
think you need to specify the base directory, ie. e:\

running with -verbose may also help sort out the problem
0
 
Giant2Commented:
try:

javadoc -doclet com.sun.tools.doclets.doccheck.DocCheck -subpackages com.pack1.pack2  -d test TheDirectoryWhereYourProjectStart


0
 
Giant2Commented:
But, why you need -subpackages oprtion?
0
 
thomas908Author Commented:
>> But, why you need -subpackages oprtion?

Becoz i have a lot of subpackages under com.
is there any otehr way of doing it ?
I am sure using subpackages is not the best way of doing it as i have to specify wach subpackage which r about 40 in number. Something like

-subpackages com.pack1: com.pack1.pack2: ....


0
 
objectsCommented:
why don't you just list the packages you want to process, or are there a lot?
0
 
thomas908Author Commented:
doing something like

E:\>javadoc -doclet com.sun.tools.doclets.doccheck.DocCheck com.pack1.pack2 -ver
bose>VerboseLog.txt -classpath d:\Libs\photos.jar;d:\Libs\log4j-1.2.7.jar;d:\Lib
s\mysql-connector-java-3.0.6-stable-bin.jar;d:\Libs\datasocket.jar; -sourcepath e:\ com -d test
0
 
thomas908Author Commented:
>>why don't you just list the packages you want to process, or are there a lot?

there are about 40 packages
0
 
thomas908Author Commented:
using subpackages option like

E:\>javadoc -doclet com.sun.tools.doclets.doccheck.DocCheck com -verbose>Verbose
Log.txt -classpath d:\Libs\photos.jar;d:\Libs\log4j-1.2.7.jar;d:\Libs\mysql-conn
ector-java-3.0.6-stable-bin.jar;d:\Libs\datasocket.jar; -sourcepath e:\ com -subpackages com.pack1.pack2.pack3:com.pack1.pack2.pack4  -d test

seems to be working. But it makes me specify names of all the subpackages, which is a problem and secondly its also giving warnings like

javadoc: warning - No source files for package com
javadoc: warning - No source files for package com
e:\com\dassault\mt\aircraft\panels\armament\ScrollablePanel.java:22: warning - @
author tag has no arguments.

0
 
thomas908Author Commented:
using subpackages option like

E:\>javadoc -doclet com.sun.tools.doclets.doccheck.DocCheck com -verbose>Verbose
Log.txt -classpath d:\Libs\photos.jar;d:\Libs\log4j-1.2.7.jar;d:\Libs\mysql-conn
ector-java-3.0.6-stable-bin.jar;d:\Libs\datasocket.jar; -sourcepath e:\ com -subpackages com.pack1.pack2.pack3:com.pack1.pack2.pack4  -d test

seems to be working. But it makes me specify names of all the subpackages, which is a problem and secondly its also giving warnings like

javadoc: warning - No source files for package com
javadoc: warning - No source files for package com
e:\com\pack1\pack2\pack3\pack4\pack5\Scroll.java:22: warning - @
author tag has no arguments.

0
 
Giant2Commented:
>javadoc: warning - No source files for package com
because you put com after DocCheck (javadoc -doclet com.sun.tools.doclets.doccheck.DocCheck com -verbose... )

I believe this could be better:
javadoc -doclet com.sun.tools.doclets.doccheck.DocCheck com.pack1.pack2 -verbose -classpath d:\Libs\photos.jar;d:\Libs\log4j-1.2.7.jar;d:\Libs\mysql-connector-java-3.0.6-stable-bin.jar;d:\Libs\datasocket.jar; -sourcepath e:\ -subpackages com.pack1.pack2.pack3:com.pack1.pack2.pack4 -d test com
0
 
Giant2Commented:
try this (I forget a com.pack1.pack2 in the statement):

javadoc -doclet com.sun.tools.doclets.doccheck.DocCheck -verbose -classpath d:\Libs\photos.jar;d:\Libs\log4j-1.2.7.jar;d:\Libs\mysql-connector-java-3.0.6-stable-bin.jar;d:\Libs\datasocket.jar; -sourcepath e:\ -subpackages com.pack1.pack2.pack3:com.pack1.pack2.pack4 -d test com
0
 
objectsCommented:
ant makes these types of tasks a lot simpler :)
0
 
thomas908Author Commented:
Even this gives 1 warning
javadoc: warning - No source files for package com


I removed com as the last word and warning in gone.

javadoc -doclet com.sun.tools.doclets.doccheck.DocCheck -verbose -classpath d:\Libs\photos.jar;d:\Libs\log4j-1.2.7.jar;d:\Libs\mysql-connector-java-3.0.6-stable-bin.jar;d:\Libs\datasocket.jar; -sourcepath e:\ -subpackages com.pack1.pack2.pack3:com.pack1.pack2.pack4 -d test

But problem of subpackages still remains. Do i need to specify names os all the 40 subpackages or is there a easier way out.
0
 
Giant2Commented:
> all the 40 subpackages or is there a easier way out
No. You can specify only the main.
For example if you have packages:
a
a.b
a.c
a.b.r
a.b.g.t

you can simply put:
-subpackages a
It generates all from package a to all its subpackages.
(see: http://java.sun.com/developer/community/chat/JavaLive/2003/jl1014.html and search in the page -subpackages)

>javadoc: warning - No source files for package com
are you sure that in e:\ there is a directory com where there are all the other packages (java code!).
0
 
thomas908Author Commented:
Thanks a lot for helping.
0
 
Giant2Commented:
Thanks.
Happy to help you.
:)
0
Question has a verified solution.

Are you are experiencing a similar issue? Get a personalized answer when you ask a related question.

Have a better answer? Share it in a comment.

Join & Write a Comment

Featured Post

Introducing Cloud Class® training courses

Tech changes fast. You can learn faster. That’s why we’re bringing professional training courses to Experts Exchange. With a subscription, you can access all the Cloud Class® courses to expand your education, prep for certifications, and get top-notch instructions.

  • 9
  • 6
  • 5
Tackle projects and never again get stuck behind a technical roadblock.
Join Now