This Bugzilla instance is a read-only archive of historic NetBeans bug reports. To report a bug in NetBeans please follow the project's instructions for reporting issues.

Bug 10270

Summary: Errors in n-line documentation for Javadoc generation.
Product: usersguide Reporter: ajacobs3 <ajacobs3>
Component: JavaAssignee: Petr Suchomel <psuchomel>
Status: CLOSED WORKSFORME    
Severity: blocker    
Priority: P4    
Version: 3.x   
Hardware: Sun   
OS: Solaris   
Issue Type: DEFECT Exception Reporter:

Description ajacobs3 2001-03-14 05:13:42 UTC
************************************************************************
************************************************************************
Searching and Generating Javadoc Documentation
  Generating Documentation With JavaDoc

After the heading "To generate documentation:" there are
five steps.  Only the first is valid.  The five steps are

  1. In the Filesystems tab of the Explorer, right-click the
     package or source file for which you want to generate
     documentation.
  2. From the contextual menu, choose Tools> Generate Javadoc.
  3. In the Javadoc Destination Directory dialog box, enter
     the name of the directory where you want to store the
     documentation.
     By default, the documentation is stored in the javadoc
     directory in your installation directory.
  4. Click OK.
     The IDE displays messages from Javadoc in an Output
     window.  An alert box asks if you want to view the
     Javadoc-generated documentation in the web browser.
  5. Click Yes.

The section should read

  In the Filesystems tab of the Explorer, right-click the
  package or source file for which you want to generate
  documentation.  The documentation is stored in the javadoc
  directory in your installation directory.  During the
  generation of the javadoc, The IDE displays messages from Javadoc
  in an Output window.  An alert box asks if you want to view the
  Javadoc-generated documentation in the web browser.

algol% runide.sh -jdkhome ${JAVA_HOME} -native
Using /home/ajacobs/nbuser32 as user directory...
-- System info ----------------------------------------------------------------
  Product Version       = NetBeans IDE, Release 3.2 beta (Build 2)
  IDE Versioning        = IDE/1 spec=1.2.1 impl=2
  Operating System      = SunOS version 5.8 running on sparc
  Java; VM; Vendor      = 1.3.1-rc1; Java HotSpot(TM) Client VM 1.3.1rc1-b18;
Sun Microsystems Inc.
  Java Home             = /usr/local/java/jdk1.3.1/solsparc/jre
  System Locale         = en
  Home Dir; Current Dir = /home/ajacobs;
export/home/ajacobs/Netbeans3.2_beta/netbeans/bin
  IDE Install; User Dir = /export/home/ajacobs/Netbeans3.2_beta/netbeans;
/home/ajacobs/nbuser32
Comment 1 Petr Suchomel 2001-03-14 08:42:19 UTC
I am preparing new notes for doc writers, in javadoc module were large number 
of changes .. current doc is for FFJ 3.0 and NB3.2 mostly unuseable
Comment 2 Petr Suchomel 2001-03-16 14:16:19 UTC
New doc for javadoc module has been sent to doc writer
Comment 3 Quality Engineering 2003-07-01 13:33:35 UTC
Resolved for 3.3.x or earlier, no new info since then -> closing.
Comment 4 Quality Engineering 2003-07-01 13:35:11 UTC
Resolved for 3.3.x or earlier, no new info since then -> closing.