Javadoc tool

is there any tool/gui exists which can help me to make the javadocs for my application ?

What does "create" mean anyway - writing the comments
or creating the HTML?some sort of auto completion . you would give the inputs e.g class name ,data type etc etc and finally you will get your javadocs as similar as Sun's javadocs.
is there any existing tool ?
i want to make the javadocs as similar as sun . i want to provide the class name,return type,field name etc etc , necessary components and i would get a javadoc like sun.
looking for a tool

Similar Messages

How to deal with #ifdef in .java files with javadoc tool?

My .java file included some '#ifdef' & '#endif' sentence. So when I used javadoc tool to generate the .html files, error happened. Can anyone give me some indication how to resolve the problem, provided that the source code can not be changed because it was written by others. Waiting for your reply and thanks in advance!

Hi, got the same problem, have stuck for all day on this and yield no progress.
my source code contain
#ifdef
and
#endif
it is source code (not comment), the only compile with a special preprocessing tool call
"sjpp.jar".
I need to generate Javadoc there.
the error is
[javadoc] C:\TEMP\cellml_visual_checkout\cellml_api\java\src\org\cellml\CNode.
java:101: illegal character: \35
[javadoc] #ifdef JENA
if I pass in encoding parameter when I do javadoc,
say, -encoding "PROPROC",
then there is different error
[javadoc] Constructing Javadoc information...
[javadoc] Standard Doclet version 1.5.0
[javadoc] Building tree for all the packages and classes...
[javadoc] java.lang.Error
[javadoc] at sun.nio.cs.StreamEncoder$CharsetSE.flushLeftoverChar(StreamEn
coder.java:361)
[javadoc] at sun.nio.cs.StreamEncoder$CharsetSE.implWrite(StreamEncoder.ja
va:381)
[javadoc] at sun.nio.cs.StreamEncoder.write(StreamEncoder.java:136)
[javadoc] at sun.nio.cs.StreamEncoder.write(StreamEncoder.java:146)
[javadoc] at java.io.OutputStreamWriter.write(OutputStreamWriter.java:204)
[javadoc] at java.io.PrintWriter.write(PrintWriter.java:384)
[javadoc] at java.io.PrintWriter.write(PrintWriter.java:401)
[javadoc] at java.io.PrintWriter.print(PrintWriter.java:532)
[javadoc] at com.sun.tools.doclets.formats.html.HtmlDocletWriter.printLink
(HtmlDocletWriter.java:1045)
[javadoc] at com.sun.tools.doclets.formats.html.MethodWriterImpl.printRetu
rnType(MethodWriterImpl.java:361)
[javadoc] at com.sun.tools.doclets.formats.html.MethodWriterImpl.writeSign
ature(MethodWriterImpl.java:148)
[javadoc] at com.sun.tools.doclets.internal.toolkit.builders.MethodBuilder
.buildSignature(MethodBuilder.java:176)
[javadoc] at sun.reflect.NativeMethodAccessorImpl.invoke0(Native Method)
[javadoc] at sun.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAcces
sorImpl.java:39)
any help will be appreciated.
thanks
Bill

Info about javadoc tool

hey
i want info about javadoc tool....................

He wasn't asking for info, just letting us know he
wanted some. Like I want a Ferarri, but I don't
expect I'll get one hereHere ya go George:
                     ...::::OI
        M~:,~???++?=:~::~~?ZNN8I. .=~==,...$I=?~.
        78OI$Z=,. .MNN....=?I?$$??I~,,,::+????++=:::D,..
        OZ..      ..N.IZ$$ZI$$Z$I?ZO$ZOI.?$87I??+~~,.~=:=+
     ..OOZ.....?IO$IZZ$Z8$D7$ZIZ7~~?8IZ??7,.+?7~::~:=...===..
      .88ZOO$7Z??$OOZZZD$O$Z$$?$I?++N8$Z7~:?.,=+++?++?$...~~+~~====~,...
      .D8OOOOOZZZ?:ZZOO8ZO$+I7+$III=NIZZ$Z?+?=.=:+7$+??+?+..7II$7IZ+:=7=$=Z:.
      .?O88OOOOOZZZZZZZ77ZZ7+III+7$?Z:+ZZZO??:?I,,.?OIIII$77Z.Z?=I$IZ$Z$Z:ZOO7Z..
        O8NN8MOOOOOZZ8NNOOZZZZ$$$+?ZN8O87Z$D=Z,??I?:,$$ZZ$$$Z$?=,.:.$ZZ$Z$Z$Z?ZZ$+..
        D8MII~$OOOOOO888OOOOZOZZ$I?+$ZZZ7$Z7+~+~ZZI==++=~~$ZI7ZZ:+ZZZZZZZZ$ZZZ$Z,=7?.
        ?ZD++87MOOOOOOOOOOOOOOOZZZZZZZZZ$$O+++$?==++????I$$Z$7Z.,+ZZZZZ..I7$ZZZZOOZ~I: .
        .$8$=?$~DODDOOOOOOOOOOOOOOOZZZZZI+ZZZZZ?+7Z$$7II$II+ZZZZ7$OO8,,.....7ZZZZOOOZZ+I.
          8M?+=IN88DDOOOOOD8OOOOOOOOOOOOOIOZZZZZZZZZI++I$$ZZZZ$Z=Z7:ZZ=...,. .,N7OZOOOOO$.
            M$=$NN88D888OOOOOOOODOOOOOOOOOOO8NNDD$DZZZZ$,.$$ZZ$Z$77Z7~I.:~...~ .ZZOZOOOOO
            .NNNNN8888888O8OOOOOOOOOOONOOOO8NMM==?NNDOZZZZZ+Z:.IZZ$ZZ7=?~.:....,..ZZZZOOOO.
             ......+M888DO8O88O8OOOOOOOONOD8N+=,N$8ZODDZZZZZZZZI..~I7$?+O8~7....,$OOOZ~ZO7.
                     ...:N888OO8O88OOOOOOOOM=I8?,+N++=NOZZZZZZZZ7ZI.$7+ZO$ZII=.,=?I$ZOOOZZ$.
                         ...,N8OOOOOOO8OOO8N+~Z$++????ODDZZZZZZZ?ZZ~$,,$OOOO$Z$$$??O?OZ88.MN.
                                 ODOO8OOOODN=:DI:+NN:DNNDNZZZZZZZZZZOOOZ$IZOO$Z7O?+=ONO8I8MD.
     .                              .?DO8O8DO:===?=I+~?=NNDDOZOZOOOZZZZZZZ?=,ZIZ$$$O7MD8ZNM.
     .                                   ...N?+.ZO=IDNN=MNZOOOOO88OOOOOOOZZZ,+8ZODOON8?OMN$.
     .                                      .M++:8$,8DIMNNZOOOOOOOZOOOO8NDOO8NZ$8OOO$I8NOD .
     .                                       .NM+7=~+?NNNNOOOOOOOOOOOOOOOOOOOOMMOOOOODMDM.
     .                                          MMNMNNNNN8OOOOOOOOOOOOOOOOOOOO8OOOOOON$N.
     .                                              .....OOOOOOOOOOOOOOOOOOOOOOO$ODNNNN.
     .                                                    .DDNNND8OOOOOOOOOOOOOZMNNMNN.
     .                                                        .=NNNNNMNNDMNNNNM=NMD8..
     .                                                             ,MN8NNMMMNM?N8...
     ........                           .     .. ................................

How to write Vietnames comments by JavaDoc tool in NetBeans IDE

Hello everybody!
I'm software technology programming of Huesoft company of VietNam and I'm researching about JavaDoc tool but I get a problem that I can't write comments and generate doccuments by Vietnames. I only know that I can open the HTML files, modify comments by Vietnames and save as HTML files with Unicode mode. However, We should not use this way because it is very not PRO. Who is know it, please help me!
Thanks!

javadoc -charset utf-8 Viet.javaIf your source files were saved in utf8 format, specify -encoding utf8 also.

How to use javadoc tool?

I am new to Java, I thought you have to manually write all the java doc comments into your source code of java application. Some one told me javadoc tool can actually automatically add the comments for you. so I tried to that with my simpliest HelloWorld.java file, but got following errors:
A:\>java HelloWorld
Hello World I am back in again,
and I WILL make it this time!
A:\>javadoc HelloWorld
Loading source files for package HelloWorld...
javadoc: No source files for package HelloWorld
1 error
A:\>
Can you help me explaining how to use automatic javadoc tool?
Thanks,
Ken

This GREAT! it worked and added bunch of .html files
into my curren directory with my HelloWorld.java.
So, it will NOT add text doc comments into my
HelloWorld.java source text code correct?
Thanks, KenThat's correct - after all, how does the tool know what you want to say in your source code unless you tell it?. There are IDE's that present a GUI interface that will make it easier for you to enter your comments, but you still have to put in the comments. Also, Sun has some style guidelines on how to document your source code that might interest you:
http://java.sun.com/j2se/javadoc/writingdoccomments/index.html

Absolutely inaccurate behaviour from javadoc tool

Hi all,
I am trying for some time now to document my code with javadoc. This code works for quite some time now and is proved stable.
The problem I have is that I can not document the whole package or a few packages together. I am getting an error message on one of my java files. Documenting just that file works fine.
The error messages are below:
C:\Program Files\JDEV\jdev\mywork\DocGen\HtmlGen>javadoc -d c:\htm -sourcepath
src datamanagement.docucreators
Loading source files for package datamanagement.docucreators...
C:\Program Files\JDEV\jdev\mywork\DocGen\HtmlGen\src\datamanagement\docucreators
\CalenderLister.java:25: '(' or '[' expected
CalendarCreator creator = new CalendarCreator;
^
C:\Program Files\JDEV\jdev\mywork\DocGen\HtmlGen\src\datamanagement\docucreators
\CalenderLister.java:28: illegal start of expression
if ()
^
C:\Program Files\JDEV\jdev\mywork\DocGen\HtmlGen\src\datamanagement\docucreators
\CalenderLister.java:28: ')' expected
if ()
^
C:\Program Files\JDEV\jdev\mywork\DocGen\HtmlGen\src\datamanagement\docucreators
\CalenderLister.java:29: illegal start of expression
^
4 errors
These messages are absolutely inacurate. I don't even have such code on the showed lines.
Also documenting the same java file: CalendarLister.java works fine.
I hope someone knows anything about that.
Thanks
Georgi

These messages are absolutely inacurate. I don't even have such
code on the showed lines.
Also documenting the same java file: CalendarLister.java works fine.You might be confusing CalendARLister.java with CalendERLister.java. I do see the bad code in CalenderLister.java
-Jamie

Please, tool for automatic java source conversion?

Hi,
Apart from Sun's jilkit, do you know a software a software that could take the
first java source below as input and automatically produce:
1) a converted java source file similar to the second file below;
2) resource files (e.g. mess.properties, mess_es_MX.properties, mess_fr_CA.properties) .
We know that Sun's jilkit does this but we tried it and it is buggy and
Sun no more supports it.
// INPUT FILE
import java.util.*;
public class Test
public static void main(String args[])
System.out.println("Hello world!");
System.out.println("You must Walk from " + args[0] + " to " + args[1] + "Km");
// OUTPUT FILE, we want this done automatically
import java.util.*;
public class Test
public static ResourceBundle resourceBundle = ResourceBundle.getBundle("messages");
public static void main(String args[])
System.out.println(resourceBundle.getString("Hello world!"));
System.out.println(
java.text.MessageFormat.format(
resourceBundle.getString("Walk from {0} to {1}Km"),
new String[]{"" + args[0], "" + args[1]}
}

The javadoc tool has no such capability. I believe some IDEs have
this, but don't know which ones. You could also look at these places:
http://java.sun.com/j2se/javadoc/faq/#docletsfromthirdparties
http://doclet.com
If you find a good tool, you might mention it here for others.
cheers,
-Doug

Javadoc out of files with extensions jpd/jws/ejb/jcx

Hi,
I see lot of messages on this newsgroup for javadoc help (unfortunately without any reply with solution except temporarily changing extension to .java).
I am facing the same problem of creating javadoc out of jpd/jws/ejb/jcx or .work file itself.
Can anyone please guide me?
regards,
-Ranjan

What do you mean "just like a java file"? Does it contain class, constructor, method and field declarations? Javadoc comments are interpreted only ahead of these declarations.
The javadoc tool is limited to java source files. It's pretty much a precondition of the javadoc tool that a source file must be able to be compiled by the javac compiler. Javadoc uses parts of javac to parse the source file and build a doc structure, using javac internal data structures. If your files cannot be compiled by javac, they are unlikely to be parsed by the javadoc tool (though there are exceptions for Java source files that have compiler errors). Javadoc tool also looks for the ".java" extension on files.

I need help!...creating Javadocs

Hi,
I am developing an application and wish to create Javadocs from the classes but don't know anything about them. Is it possible to write the command that you use to invoke JavaDoc in a .BAT file and if so, how do I do this?.....I use the JPad editor and use the compile and run buttons in it!...I don't use the C:> javac..... commands!!....is it possible to add some sort of code to create the Javadocs when I run my application using JPad??
Please help, this is really urgent!!
Thanks.

Sun Javadoc tool has a programmatic interface with public methods for invoking the javadoc tool from another java program. Hope it would solve your beed of executing Javadocs within your application.
For details, refer to
http://java.sun.com/j2se/1.4/docs/tooldocs/javadoc/standard-doclet.html#running
Regards

Javadoc formatting

My javadoc output keeps prefixing package names for common Java classes. For example, in a method with return type String it will print java.lang.String. Is there a way to fix this? These fully-qualified class names really clutter up the documentation.
thanks,
Eric

I believe you need to set one of the Javadoc tool options to include the path to the JDK API documentation.
Try looking through here:
http://java.sun.com/j2se/1.4.2/docs/tooldocs/javadoc/

Private constructor documented as public by javadoc

I'm generating document for a class similar to the following:
public class Example {
public static final Example TYPE1 = new Example();
public static final Example TYPE2 = new Example();
private Example() {
// private constructor
When I run the Javadoc tool on this class, it lists the constructor as being public, which it is not! Is this a bug in javadoc, or am I doing something wrong?

I think I can explain it.
I would bet you first created the class without any constructor
and ran Javadoc on it.
In that case, not only does javac create a public default
no-arg constructor, but javadoc also documents that constructor,
even though it's not present in the source file.
Later, when you added the private constructor, that prevented
the default constructor from being automatically created.
This is documented at:
http://java.sun.com/docs/books/jls/second_edition/html/classes.doc.html#16823
BTW, we consider relying on default constructors as poor programming
practice, as described at:
http://java.sun.com/j2se/javadoc/writingdoccomments/index.html#defaultconstructors
-Doug Kramer
Javadoc team

[Sun One ME Javadoc]

Hi!
I'm generating Javadocs thanks to Sun One ME, but I encounter
this sort of problems:
C:\MobileApplications\sampledir\MyWork\Midlet.java:9: package javax.microedition.midlet does not exist
import javax.microedition.midlet.*;
I don't encouter problems when I compile my programm
neither while loading the .jad file.
So, what's the problem with the javadoc tool?
Is there a path to specify, settings to make?
Thanks,
RocJap
PS: I'm not sure my post should be here,
sorry if it is not in the right place :)

Hi there,
Just to let you all know that I've figured it out!(Thanks to Dougs advice above) To get the J2ME class files recognised, you need to first go into the J2MEWTK wireless toolkit folder, and into the 'lib' subfolder, and unzip the 'midpapi.zip' file to a convienient place,...we'll assume its called 'mylib' for now...
afterwards, navigate through the command prompt to the source files...,
and type:
javadoc -classpath x:\mylib\ -d html -breakiterator *.java
....................^^ your path of unzipped midp api!
voila! everything should work ok, if anyone experiences something similar to me, follow my example, or let me know!
cheers,
Jassen

How to run Javadoc on more than one project

In my web application, I have two projects: Model and ViewController.
I want to run JavaDoc on both Model project and ViewController Project combined.
But JDeveloper only allows me to run them separately.
Is it possible to generate Javadoc for all the classes in my application?
JDeveloper 10.1.3.3

Hi,
there is o option in JDeveloper for this. Maybe the javadoc tool in the JDK allows you to build docs for two source directories (haven't tried though)
Frank

Sqlj files are not processed by javadoc

Hi,
I have a projects containing java files stored in database. Some of them contain SQLJ code and exist in the projects as *.sqlj files. When I create build javadoc documentation these *.sqlj files are ignored and the resulting documentation is missing some of the classes. Did anyone encountered the same problem?
Best wishes,
Tomek

Javadoc will not work on SQLJ files. An excerpt from a thread on the javadoc forum at Sun (for some reason, I cannot access the post, but Google has a cache of it):
>
The javadoc tool is limited to java source files. It's pretty much a precondition of the javadoc tool that a source file must be able to be compiled by the javac compiler. Javadoc uses parts of javac to
parse the source file and build a doc structure, using javac internal data structures. If your sqlj file cannot be compiled by javac, they are unlikely to be parsed by the javadoc tool. John

Using Javadoc with generics

hi, I have not yet found a way to use javadoc on my sources which contain some generics. The tool fails (with errors) and will eventually abort. Is there a doclet or a modified javadoc tool that will work?
error example:
AbstractModel.java:7: '{' expected
abstract public class AbstractModel<M> implements Model<M>

Now it works for me on Netscape, when oddly it didn't
yesterday. Hmmm... I didn't change a thing. Could it have been that you didn't have the "All Classes" frame open? This implementation is sensitive to that. No; you would still have gotten the "not found" dialog.
It seems to be case-sensitive, and require the full
name, which are unexpected, but understandable.Do you think it would be more effective if it were case-insensitive? It's a trivial fix, but since Java is decidedly case-sensitive, I went for that.
Yes, it also requires a correct class name, and not a substring. Not the fulIy-qualified name, though. (That's the whole point; usually I don't remember the fully-qualifed class name.) This can be altered, but you certainly don't want the first substring match to be the class opened.
A big limiting factor is that JavaScript is often really slow. You'll see that if you search for "Applet" it comes up fast because it's early in the list; searching for "ZoneView" takes forever. (You should have seen how slow in older versions of Mozilla.)
If you have to search through the whole list, such as for a "best" substring match, it will tend to always be slow.
I once had a substring search; it gives more trouble than it solves, and leads to more "unexpected" behavior than the current solution. If someone searches for "Link", what should the search show them? There are loads of classes that start with or contain "Link." Maybe just pop up a message box that shows the names of all the possible completions? (I'm not trying to over-engineer this; JavaScript could be made to open new windows, and generate new HTML documents, with select lists, but I'm not sure it's a desirable solution. And "unwanted pop-up blocking" (I love you, Mozilla!) would make none of it work. )
It's ironic that the search field seems to require
the presence of the All Classes list, and yet
somewhat
obsoletes its use (except when wanting to browse
through
names).Well, as you know, JavaScript "introspection" (if you will) requires that the document to be searched is loaded and parsed into a frame on-screen. No real way around that. (I think that using a hidden frame, or popping up a new window, is a horrible idea, so I'm not considering it.) Note that if you have the java.awt classlist open in the lower-left frame, searching for Button WILL work. This may actually be desirable behavior. Note that there are lots of name collisions in Java if you just consider the unqualified class name. If you're working with the AWT, and have the list of AWT classes open in that window, you probably want the AWT List to come up, not the Collection class List.
Maybe, if the class name is not found on the first pass, check the URL of the document loaded in the lower-left frame; then JavaScript can force that frame to reload the "All Classes" window if it's not the one loaded. I wouldn't do it automatically; that behavior may be annoying to users, or it may cause problems like the "List" example above. I'd ask them "Not found in (package x). Do you want to search in all packages?" using a JavaScript confirm() dialog first.
Another benefit and problem that's not obvious: the current solution works on JavaDocs that I've generated, too. You don't want to default to the Java distribution's "All Classes", and you may not even know where the canonical Java docs are to be found, so you can't do the trick listed in the previous paragraph.
Does JavaScript allow it to be modified to overcome
these limitations? Yes, mostly, but with tradeoffs, as discussed above.
Or could it be made to search
through
the index instead, so you could provide a method
before
choosing a class? If the index was on the screen, it could be searched. I'm not sure which class you'd pull up if there were multiple matches.
The current solution isn't meant to be a fix-all searching solution for everything; it's pretty obvious that there are limitations to what JavaScript can and should do. It all depends on what you want to support (including whether you care about browser independence.) This solution is a quick-n-dirty one designed to jump to a known class very quickly without scrolling all through those ever-growing lists, which is all I need 95% of the time. It sounds like you have bigger plans.
The idea of making a little Java Documentation Server that supplies documentation from a compressed file is a better long-term solution, in my opinion. It could do really powerful searches, and be browser-independent (i.e. not requiring JavaScript at all, which is something I don't like about the portability of my solution; I'd rather do everything from within Emacs,) and reduce the space used by Java documentation. I've written such a server in Perl, and I'm very pleased with the space savings, and the fact that it can uncompress and syntax-highlight source files on demand.
I'm hoping that this discussion might save you some time if you decide that this JavaScript-based approach is an approach you want to take for the distribution. Doing this in JavaScript as I've done works, for what I need most, but may not be ideal for the rest of the world.

Javadoc tool

Similar Messages

Maybe you are looking for