Package description in Javadoc

Hi to all !!
How can I add a comment to a package in Javadoc?
A comment may be a description of package content
like this:
com.myself.package This packages contains 2 classes.
I want that description of package appears in the "Overview"
page in the Javadoc documentation.
I hope that someone help me.
Thanks.
emilio

Should be somewhere in here:
http://java.sun.com/j2se/javadoc/index.jsp

Similar Messages

Build error :package com.sun.javadoc does not exist

Question from a Turing machine expert who is new to Java.
Trying to run a sample program from Richardson's book "Java JDK 5 Edition" Chapter 1.
In Netbeans 5.5 receive build error :package com.sun.javadoc does not exist
for "import com.sun.javadoc.*;"
Believe missing classes are in tools.jar in C:\Sun\SDKee5SDK\jdk\lib
How do I define this to Netbeans and/or JDK?
Using java_ee_sdk-5_01
and netbeans-5_5-windows downloads.
Platform is XP.
Netbeans has been updated to date.
Appreciate.

sony_tj wrote:
D:\Xyz.java:22: package com.sun.javadoc does not exist
import com.sun.javadoc.*;After getting this error, I have set my classpath to C:\Program Files\Java\jdk1.5.0_03\lib\tools.jar. But still the error persists. Could anyone please tell me how do I solve this problem.You have failed in setting your classpath in that case.

Package com.sun.javadoc does not exist

D:\Xyz.java:22: package com.sun.javadoc does not exist
import com.sun.javadoc.*;After getting this error, I have set my classpath to C:\Program Files\Java\jdk1.5.0_03\lib\tools.jar. But still the error persists. Could anyone please tell me how do I solve this problem.

sony_tj wrote:
D:\Xyz.java:22: package com.sun.javadoc does not exist
import com.sun.javadoc.*;After getting this error, I have set my classpath to C:\Program Files\Java\jdk1.5.0_03\lib\tools.jar. But still the error persists. Could anyone please tell me how do I solve this problem.You have failed in setting your classpath in that case.

[svn] 3652: Fix for SDK-17328 - Package description missing when they' re set using Overviews_Base.xml

Revision: 3652
Author: [email protected]
Date: 2008-10-15 10:18:08 -0700 (Wed, 15 Oct 2008)
Log Message:
Fix for SDK-17328 - Package description missing when they're set using Overviews_Base.xml
Fix for SDK-17185 - Allow HTML chars to be set for footer string
Fix for SDK-17259 - Exception name missing when generating asdoc with @throw tag
QA: Yes
Doc: No
Tests: checkintests
Ticket Links:
http://bugs.adobe.com/jira/browse/SDK-17328
http://bugs.adobe.com/jira/browse/SDK-17185
http://bugs.adobe.com/jira/browse/SDK-17259
Modified Paths:
flex/sdk/trunk/asdoc/templates/asdoc-util.xslt
flex/sdk/trunk/asdoc/templates/package-detail.xslt
flex/sdk/trunk/modules/compiler/src/java/flex2/compiler/asdoc/TopLevelClassesGenerator.ja va

I believe I have found my solution!
I can currently boot with my bios in ide mode- but my raid1 mirror is showing as independent drives (c and d)
I do a simple windows search for winload.exe on the C: drive and get nothing
that same search on the D: turns up winload.exe all over
When I look at I my BCD 'device partation=C:'
shouldnt this be D:?
If so is this just a simple bcdedit, reboot into the bios, change my bios from IDE mode to RAID mode, save to cmos then, theoretically boot into windows with my raid correct (showing as a singe drive C: )
Please someone correct me if I am wrong
C:\>bcdedit
Windows Boot Manager
identifier              {bootmgr}
device                  partition=C:
description             Windows Boot Manager
locale                  en-US
inherit                 {globalsettings}
default                 {current}
resumeobject            {8b18c20b-c12d-11db-afc2-ac36bbabc8b2}
displayorder            {current}
toolsdisplayorder       {memdiag}
timeout                 30
Windows Boot Loader
identifier              {current}
device                  partition=C:
path                    \Windows\system32\winload.exe
description             Microsoft Windows Vista
locale                  en-US
inherit                 {bootloadersettings}
osdevice                partition=C:
systemroot              \Windows
resumeobject            {8b18c20b-c12d-11db-afc2-ac36bbabc8b2}
nx                      OptIn
vga                     No
quietboot               Yes

GNOME 2.0 Desktop - required package descriptions

We're planning to begin experimenting with the GNOME desktop on some SPARC machines running Solaris 8. I'm trying to find a description of the packages included in the list of "Additional Packages" that get installed by the GNOME Install Wizard. My searches on the SUN website have all ended up in the GNOME installation guide... with no package descriptions provided. Where can I find descriptions of these required packages?

Personally I think JDS3 is a bit awkward and
certainly not as nice to use as Gnome2. I was
disappointed to see the CDE apps menu has disappeared
too, I had to figure out where certain apps are on
the HDD, something I never thought to do in the past.
Specifically I was looking for SMC, which I
eventually found in /usr/sadm/bin/smc.
I was under the impression from Sun's own
documentation, that Gnome would be the replacement
for CDE, I figured they'd included it with latter
Solaris9 installs as a stop gap. I also noticed that
when I installed Solaris10, I saw a message box
mention KDE a few times so I expected to see an
option for KDE as well. Dunno if it's hidden away
somewhere but I'd sure like to know what it was all
about.I wonder whether one can get rid of some of the JDS stuff and just use the GNOME part. I never understood why so many of the desktop environments try to immitate Windows even to the extent that there is a launch (aka start) button.
Matthias

[svn:fx-trunk] 8245: adding option (package-description-file) to specify file containing package descriptions for asdoc.

Revision: 8245
Author:   [email protected]
Date:     2009-06-25 12:07:07 -0700 (Thu, 25 Jun 2009)
Log Message:
adding option (package-description-file) to specify file containing package descriptions for asdoc.
Bugs: SDK-19755
QE Notes: None.
Doc Notes: None.
Reviewed by: Paul
Ticket Links:
    http://bugs.adobe.com/jira/browse/SDK-19755
Modified Paths:
    flex/sdk/trunk/modules/antTasks/src/flex/ant/AsDocTask.java
    flex/sdk/trunk/modules/compiler/src/java/flex2/compiler/asdoc/AsDocAPI.java
    flex/sdk/trunk/modules/compiler/src/java/flex2/configuration_en.properties
    flex/sdk/trunk/modules/compiler/src/java/flex2/tools/ASDocConfiguration.java

Revision: 8245
Author:   [email protected]
Date:     2009-06-25 12:07:07 -0700 (Thu, 25 Jun 2009)
Log Message:
adding option (package-description-file) to specify file containing package descriptions for asdoc.
Bugs: SDK-19755
QE Notes: None.
Doc Notes: None.
Reviewed by: Paul
Ticket Links:
    http://bugs.adobe.com/jira/browse/SDK-19755
Modified Paths:
    flex/sdk/trunk/modules/antTasks/src/flex/ant/AsDocTask.java
    flex/sdk/trunk/modules/compiler/src/java/flex2/compiler/asdoc/AsDocAPI.java
    flex/sdk/trunk/modules/compiler/src/java/flex2/configuration_en.properties
    flex/sdk/trunk/modules/compiler/src/java/flex2/tools/ASDocConfiguration.java

Package info in javadoc

hi folks,
Can any one tell me how to get Package info in the Java Doc??
ie how to include comment in source code so as to get the Package
info in the javadoc ??
ex
package hiall;
* @param args
public class Hello {
} will print only the class info

Why we can not import a user defined package as an ordinary java package that is
java.swing.*;
we have to explicitly menction that class name inorder to import that specified class that is like
giri.addints;
Here giri is my own package and addints is class..........
it is not going to work if import as
import giri.*;
with regards...

Include Core Java Package While using Javadoc

Hi there:
I have developed a java package which import the JavaSQL package. I would like to generate the technical document via Javadoc and include the JavaSQL APIs. Any idea?
Thanks, Joseph

Use the '-link' option of the standard doclet. This example will allow you to link to Sun's api's directly. Of course, you could also provide a link to an internal URL (could also be a file:// URL) where the SDK javadocs are located.
javadoc mypackage [...] -link http://java.sun.com/j2se/1.4.1/docs/api/

How can i indclude my own package when using 'javadoc'

hello,
i create my own package, say myPackage.
can i include it when using javadoc
thanks

In case you didn't get it from that last answer: You are not supposed to explicitly specify the java files, just the packages (the directories).
Cut-and-paste from the earlier supplied information:
Case 3 - Run from any directory on explicit packages in a single directory tree - In this case, it doesn't matter what the current directory is. Run javadoc supplying -sourcepath with the parent directory of the top-level package, and supplying names of one or more packages you want to document:
C:> javadoc -d C:\home\html -sourcepath C:\home\src java.awt java.awt.event
If you need to document more than one package, add a ";" and the package after the "C:\home\src" or whatever your package is called.
-d directory
Specifies the destination directory where javadoc saves the generated HTML files.
-sourcepath sourcepathlist
Specifies the search paths for finding source files (.java)
best of luck
-negal

Package description in the system

Hello
How can we find out whether a support package is been installed in the system or not.Please let me know
thanks

Hi,
Goto sytem --> status n expand the component version
or
use transaction code "SPAM" . here u can display the new support packages that has been installed
Hope this helps,
regards,

[REQUEST] mesa-apps package description

I think mesa-apps description must contain words glxinfo and glxgears, so people can easily find these useful apps

+1
Even if 3D isn't working for me atm -> see this post
Cheerio Sigi

Javadoc tree description

I can happily get package description to work, but how do I add a description for my whole javadoc tree?
eg at
http://java.sun.com/j2se/1.4.1/docs/api/
the tree description is:
JavaTM 2 Platform, Standard Edition, v 1.4.1
API Specification
This document is the API specification for the Java 2 Platform, Standard Edition, version 1.4.1.
I want to add one of these how do I do it?

This is called the "overview", and is described at great length at:
http://java.sun.com/j2se/1.4/docs/tooldocs/windows/javadoc.html#overviewcomment
-Doug Kramer
Javadoc team

[SOLVED] search just package name (not description) with yaourt

Is there a way to search just package names (not package descriptions) with yaourt or pacman? I'm imagining something like this:
$ yaourt -Ss --pkgname-only xterm
Thanks!
Last edited by partner55083777 (2010-02-03 16:30:43)

My question still stands as to how I can search just package names. If it is using another program other than yaourt or pacman, that is okay.
"yaourt -Ss SEARCH_STRING" has been working as stated in the documentation for me (with yaourt-0.9.2.6). It will return all packages that have SEARCH_STRING in either the package name or package description.
Here are the first three results when running this command:
$ yaourt -Ss emacs
extra/emacs 23.1-3 [installed]
The Emacs Editor
extra/snd 10.1-1
Snd is the emacs of sound editor
extra/texmacs 1.0.7-3
GNU TeXmacs is a free scientific text editor, which was both inspired by TeX
and GNU Emacs. WYSIWYG editor TeX-fonts and CAS-interface (Giac, GTybalt,
Macaulay 2, Maxima, Octave, Pari, Qcl, R and Yacas) in one.
$
It looks like it works as specified in the man pages:
-s, --search <'regexp'>
This will search each package in the sync databases for names or descriptions that match regexp.
When you include multiple search terms, only packages with descriptions matching ALL of those terms will be returned.
Last edited by partner55083777 (2010-02-02 22:10:24)

[svn] 696: Added package level and class level javadoc, where is was missing.

Revision: 696
Author: [email protected]
Date: 2008-02-29 11:49:08 -0800 (Fri, 29 Feb 2008)
Log Message:
Added package level and class level javadoc, where is was missing.
Modified Paths:
flex/sdk/trunk/modules/compiler/src/java/flex2/compiler/mxml/rep/AnonymousObjectGraph.jav a
flex/sdk/trunk/modules/compiler/src/java/flex2/compiler/mxml/rep/Array.java
flex/sdk/trunk/modules/compiler/src/java/flex2/compiler/mxml/rep/AtEmbed.java
flex/sdk/trunk/modules/compiler/src/java/flex2/compiler/mxml/rep/AtResource.java
flex/sdk/trunk/modules/compiler/src/java/flex2/compiler/mxml/rep/LineNumberMapped.java
flex/sdk/trunk/modules/compiler/src/java/flex2/compiler/mxml/rep/Model.java
flex/sdk/trunk/modules/compiler/src/java/flex2/compiler/mxml/rep/MovieClip.java
flex/sdk/trunk/modules/compiler/src/java/flex2/compiler/mxml/rep/MxmlDocument.java
flex/sdk/trunk/modules/compiler/src/java/flex2/compiler/mxml/rep/Primitive.java
flex/sdk/trunk/modules/compiler/src/java/flex2/compiler/mxml/rep/Script.java
flex/sdk/trunk/modules/compiler/src/java/flex2/compiler/mxml/rep/XML.java
flex/sdk/trunk/modules/compiler/src/java/flex2/compiler/mxml/rep/XMLList.java
Added Paths:
flex/sdk/trunk/modules/compiler/src/java/flex2/compiler/mxml/rep/package.html

Hi,
The javadoc is generated to directory /home/usr/doc and I have added a package.html as mentioned. But no change found.
There is also no package directory in the /doc.
My original problem is that in the index.html, there are three frames, the right hand side frame showing the overwiew. In the overview page, there is the table of packages with two columns, the left columns showing the package name, while the right column showing blank.
How to generate comments to the right column in the table in the right hand side frame in the index.html?
Thanks,
Wing

JavaDoc issue: @see tags not displaying properly

I am having a very odd issue that I cannot seem to figure out. I am trying to add the following lines to a comment on a specific method:
@see javax.mail.internet.MimeMessage#setSubject(java.lang.String)
@see java.util.Properties#getProperty(java.lang.String)
My problem is, when the html is generated...it shows
See also:
MimeMessage, Properties.getProperty(java.lang.String)
I have both the J2SE and J2EE documentation linked so that these are linked to the source api on sun's site. When I click on MimeMessage it does send me to the setSubject() method within the MimeMessage class. So why does it not show MimeMessage.setSubject(java.lang.String)? Instead it just shows the class name. And why does Properties.getProperty(java.lang.String) properly show on the documentation but the MimeMessage class does not show the specific method it is linking to?

Here is my set of @see tags for this method:
@see javax.mail.Session#getInstance(java.util.Properties, javax.mail.Authenticator)
@see javax.mail.internet.MimeMessage#setRecipients(javax.mail.Message.RecipientType, javax.mail.Address[])
@see javax.mail.internet.MimeMessage#setSentDate(java.util.Date)
@see javax.mail.internet.MimeMessage#setSubject(java.lang.String)
@see javax.mail.internet.MimeMessage#setHeader(java.lang.String, java.lang.String)
@see java.util.Properties#getProperty(java.lang.String)
@see java.util.Properties#list(java.io.PrintStream)
@see javax.mail.internet.MimeMessage#setFrom(javax.mail.Address)
@see java.io.StringWriter#write(java.lang.String)
@see javax.mail.internet.MimeBodyPart#setContent(java.lang.Object, java.lang.String)
@see javax.mail.Multipart#addBodyPart(javax.mail.BodyPart)
@see javax.mail.Transport#send(javax.mail.Message)And here is what it outputs on the documentation:
See Also:
Session, MimeMessage, MimeMessage, MimeMessage, MimeMessage, Properties.getProperty(java.lang.String), Properties.list(java.io.PrintStream), MimeMessage, StringWriter.write(java.lang.String), MimeBodyPart, Multipart, Transport
I am using an ant build to generate the documentation, here is the javadoc target:
<target name="javadoc" description="Generates javadoc">
     
     <script language='javascript' src='./WebContent/js/javadocs/javadocBackup.js'></script>
     <delete dir="${backupdoc.dir}" failonerror="false"/>
     <move file="${doc.dir}" tofile="${backupdoc.dir}"/>
     <delete dir="${doc.dir}" failonerror="false"/>
     <mkdir dir="${doc.dir}" />
     <javadoc destdir="${doc.dir}" access="package" use="true" notree="false" nonavbar="false"
          noindex="false" splitindex="true" author="true" version="true" nodeprecatedlist="false"
          packagenames="us.or.state.dhs.*" sourcepath="${src.dir}" doctitle="${project.name}"
          windowtitle="${project.name} - API reference." stylesheetfile="../documents/javadocs.css"
          bottom="<script src='../../WebContent/js/javadocs/javadocTopBanner.js'></script>">
          
          <link href="http://java.sun.com/j2ee/1.4/docs/api/"/>
          <link href="http://java.sun.com/j2se/1.4.2/docs/api"/>
     </javadoc>
</target>It is just really odd that the classes within the j2se docs are displaying correctly whereas the j2ee classes are not. The j2see classes link correctly and point to the correct methods when you click on them. They just aren't displaying correctly as you see above with the 4 MimeMessage classes and the Session, Transport, etc.
Any help is appreciated, thanks for responding! :)

Package description in Javadoc

Similar Messages

Maybe you are looking for