Re: javadocs and constructors

[Isaac Sparrow]

On Tuesday 28 August 2001 02:26 pm, you wrote:
> I did, and it read classes and members, not constructors ;)
>
> Thanks though :)

No. Javadoc does not document private fields, methods, or PRIVATE 
constructors by default (constructors are really just methods. They actually 
return void if you look at the byte code). You have to tell Javadoc to 
document anything private. See below:

<snip>
<javadoc packagenames="${javadoc.packages}"
                private="true"  <!-- document the private parts... -->
          verbose="false"
                sourcepath="${src.dir}"
                destdir="${javadoc.dir}"
                author="true"
                version="true"
                use="true"
                windowtitle="window title"
                doctitle="doc title"
                bottom="Copyright &#169; 2001 All Rights Reserved.">
</snip>
Hope this helps,

--Isaac Sparrow
Staff Engineer
VisiComp, Inc.
http://www.visicomp.com
------------------------------
Brain fried -- Core dumped




>
> ----- Original Message -----
> From: "Erik Hatcher" <[EMAIL PROTECTED]>
> To: <[EMAIL PROTECTED]>
> Sent: Tuesday, August 28, 2001 3:11 PM
> Subject: Re: javadocs and constructors
>
> > Try out the "Private" attribute on <javadoc>.   When in doubt... RTFM!
> >
> >     Erik
> >
> >
> > ----- Original Message -----
> > From: "T Master" <[EMAIL PROTECTED]>
> > To: "ant user mailist" <[EMAIL PROTECTED]>
> > Sent: Tuesday, August 28, 2001 2:03 PM
> > Subject: javadocs and constructors
> >
> > > My private constructors are not showing up in my javadocs.  I am using
> > > ant1.4 beta2.
> > > Is there a way to show them?
> > >
> > >     <target name="javadocs" depends="init">
> > >         <echo message="Creating javadocs into ${javadoc.dir}..."/>
> > >         <javadoc packagenames="${javadoc.packages}"
> > >                verbose="false"
> > >                sourcepath="${src.dir}"
> > >                destdir="${javadoc.dir}"
> > >                author="true"
> > >                version="true"
> > >                use="true"
> > >                windowtitle="window title"
> > >                doctitle="doc title"
> > >                bottom="Copyright &#169; 2001 All Rights Reserved.">
> > >             <group title="Client packages"
> > >                     packages="com.blah.bleh.*"/>
> > >             <!--link offline="true"
> > >                   href="http://java.sun.com/products/jdk/1.3/docs/api/";
> > >                   packagelistLoc=""/-->
> > >             <link
> > > href="http://developer.java.sun.com/developer/products/xml/docs/api/"/>
> > >       </javadoc>
> > >     </target>

--