Java-Gaming.org Hi !
Featured games (83)
games approved by the League of Dukes
Games in Showcase (517)
Games in Android Showcase (123)
games submitted by our members
Games in WIP (577)
games currently in development
News: Read the Java Gaming Resources, or peek at the official Java tutorials
 
    Home     Help   Search   Login   Register   
Pages: [1]
  ignore  |  Print  
  javadoc - how to document packages  (Read 2768 times)
0 Members and 1 Guest are viewing this topic.
Offline Conzar

Junior Duke




There is nothing common about common sense


« Posted 2003-02-21 16:13:08 »

Hey,
 I have not used javadoc and would like to start - I usually develope my own api (usually included in my users manual); however, I think the users of the software I am currently developing will benifit from the javadoc style most java developers are occustomed to.  

Anyways, I have looked at sun's site on java doc and found this

http://java.sun.com/j2se/1.4/docs/tooldocs/solaris/javadoc.html#sourcefiles

and

http://java.sun.com/j2se/javadoc/writingdoccomments/index.html

Both talk about package level comments.  You basicaly but a package.html file in the root of each package directory.  For instance, you have a package called foo.bar with a class in foo/bar/Old.java
What I want to do is document each root directory.

foo/package.html
foo/bar/package.html

I want to describe the package foo in this html file but I do not want any .java files in the root of foo (its not approriate here)

I get an error from java doc when I do this
javadoc foo
javadoc: No source files for package foo

However, if I do javadoc foo.bar.Old   then it produces semi-right stuff (it doesn't include the comments I had  in the package.html found in foo/bar/)

Anyone have any suggestions?  Can you have a package.html w/out a coresponding .java file?  


Ubuntu
Offline leknor

Junior Duke




ROCK!!!


« Reply #1 - Posted 2003-02-22 02:41:46 »

Quote
Anyone have any suggestions?  Can you have a package.html w/out a coresponding .java file?
I don't think so. An empy package may as well not exists.

Why do you want an empty package? If you're trying to create a "plugins" package or something where classes are loaded at runtime from that package you may find SPI useful.
Offline Conzar

Junior Duke




There is nothing common about common sense


« Reply #2 - Posted 2003-02-22 13:05:47 »

I want a package that doesn't not have any .java files because all of the packages below it don't make sense by themselves.

For instance, say you have a program that has a client and server.  It would be nice to connect them by some global package name.  

So you could have foo.client and foo.server.
So you could have  package level comment about foo.

Does that make sense?

Ubuntu
Games published by our own members! Check 'em out!
Legends of Yore - The Casual Retro Roguelike
Offline Conzar

Junior Duke




There is nothing common about common sense


« Reply #3 - Posted 2003-02-22 13:45:20 »


This is what I want to do ...

http://java.sun.com/j2se/1.4/docs/api/overview-summary.html

THere are no classes in this package; however, there are packages

Ubuntu
Offline Conzar

Junior Duke




There is nothing common about common sense


« Reply #4 - Posted 2003-02-22 15:11:51 »

Ok,  Found a solution to my own question.

You can do what I'm talking about but instead of using a package.html file in the root directory, put an overview.html file (it can be the same format as package.html).

Run javadoc -overview foo/overview.html -subpackages foo

Oh yea, make sure you do
unset CLASSPATH
b/c javadoc might try to run through your classes twice and complain about duplicate entries.

Ubuntu
Pages: [1]
  ignore  |  Print  
 
 
You cannot reply to this message, because it is very, very old.

 

Add your game by posting it in the WIP section,
or publish it in Showcase.

The first screenshot will be displayed as a thumbnail.

TehJavaDev (37 views)
2014-10-27 03:28:38

TehJavaDev (29 views)
2014-10-27 03:27:51

DarkCart (43 views)
2014-10-26 19:37:11

Luminem (24 views)
2014-10-26 10:17:50

Luminem (29 views)
2014-10-26 10:14:04

theagentd (35 views)
2014-10-25 15:46:29

Longarmx (63 views)
2014-10-17 03:59:02

Norakomi (61 views)
2014-10-16 15:22:06

Norakomi (50 views)
2014-10-16 15:20:20

lcass (45 views)
2014-10-15 16:18:58
Understanding relations between setOrigin, setScale and setPosition in libGdx
by mbabuskov
2014-10-09 22:35:00

Definite guide to supporting multiple device resolutions on Android (2014)
by mbabuskov
2014-10-02 22:36:02

List of Learning Resources
by Longor1996
2014-08-16 10:40:00

List of Learning Resources
by SilverTiger
2014-08-05 19:33:27

Resources for WIP games
by CogWheelz
2014-08-01 16:20:17

Resources for WIP games
by CogWheelz
2014-08-01 16:19:50

List of Learning Resources
by SilverTiger
2014-07-31 16:29:50

List of Learning Resources
by SilverTiger
2014-07-31 16:26:06
java-gaming.org is not responsible for the content posted by its members, including references to external websites, and other references that may or may not have a relation with our primarily gaming and game production oriented community. inquiries and complaints can be sent via email to the info‑account of the company managing the website of java‑gaming.org
Powered by MySQL Powered by PHP Powered by SMF 1.1.18 | SMF © 2013, Simple Machines | Managed by Enhanced Four Valid XHTML 1.0! Valid CSS!