You are viewing a plain text version of this content. The canonical link for it is here.
Posted to user@ant.apache.org by "Chadha, Ankush" <An...@fatwire.com> on 2007/05/25 18:15:56 UTC
Javadocs with Generics
Hi All
I am using javadoc (ant task) to generate javadoc of my source files.
I have set the source and the ant's magic property for java and javac to
1.5 but still the generics are not included in the final javadoc.
However if I generate the javadoc through my IDE, the generics are
included.
Any suggestions for the same?
Best
Ankush
Re: Javadocs with Generics
Posted by "Scot P. Floess" <fl...@mindspring.com>.
Ankush:
Good question there.. Quite honestly I have always javadoc'd my methods
and class headers... I hate to admit it...but not sure and sorta busy
today so I can't experiment / research :(
Chadha, Ankush wrote:
> Scot,
>
> Here are the details:
>
> Sample Code:
> ===========
> public synchronized List<Myclass> getFoo (String name)
> {
>
> }
>
> Javadoc:
> =======
> java.util.List getFoo(java.lang.String name)
>
> I am using JDK 1.5.0_06
>
> Best
> Ankush
>
> -----Original Message-----
> From: Scot P. Floess [mailto:floess@mindspring.com]
> Sent: Friday, May 25, 2007 12:40 PM
> To: Ant Users List
> Subject: Re: Javadocs with Generics
>
> Ankush:
>
> What does your call to <javadoc> look like?
>
> I know that I am not doing anything special to ensure the generics
> output correctly... For instance:
>
> <javadoc sourcepath = "${jplate-build.JAVA_SRC_PATH}" classpath =
> "${jplate-build.JAVA_CLASSES_HOME}" destdir =
> "${jplate-build.JAVA_DOC_GENERATED_HOME}" packagenames =
> "${jplate-build.JAVA_DOC_PACKAGE_NAMES}" author = "true" private =
> "true" windowtitle = "${jplate-build.JAVA_PROJECT_NAME}" overview =
> "${jplate-build.JAVA_DOC_OVERVIEW_FILE}"/>
>
> I am not specifying any target attribute as I am currently using JDK
> 1.6.0 - but that shouldn't matter...
>
> Silly question: are you sure your internal Javadocs (meaning in the
> java source file) are correctly laid out? I know when I incorrectly
> defined my generics, they didn't output at all...
>
> Can we see a sample of your Java code?
>
> Chadha, Ankush wrote:
>
>> Hi All
>>
>> I am using javadoc (ant task) to generate javadoc of my source files.
>> I have set the source and the ant's magic property for java and javac
>> to
>> 1.5 but still the generics are not included in the final javadoc.
>> However if I generate the javadoc through my IDE, the generics are
>> included.
>>
>> Any suggestions for the same?
>>
>> Best
>> Ankush
>>
>>
>>
>
> --
> Scot P. Floess
> 27 Lake Royale
> Louisburg, NC 27549
>
> 252-478-8087 (Home)
> 919-392-6730 (Work)
>
> Chief Architect JPlate http://sourceforge.net/projects/jplate
> Chief Architect JavaPIM http://sourceforge.net/projects/javapim
>
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: user-unsubscribe@ant.apache.org For additional
> commands, e-mail: user-help@ant.apache.org
>
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: user-unsubscribe@ant.apache.org
> For additional commands, e-mail: user-help@ant.apache.org
>
>
>
--
Scot P. Floess
27 Lake Royale
Louisburg, NC 27549
252-478-8087 (Home)
919-392-6730 (Work)
Chief Architect JPlate http://sourceforge.net/projects/jplate
Chief Architect JavaPIM http://sourceforge.net/projects/javapim
RE: Javadocs with Generics
Posted by "Chadha, Ankush" <An...@fatwire.com>.
Scot,
Here are the details:
Sample Code:
===========
public synchronized List<Myclass> getFoo (String name)
{
}
Javadoc:
=======
java.util.List getFoo(java.lang.String name)
I am using JDK 1.5.0_06
Best
Ankush
-----Original Message-----
From: Scot P. Floess [mailto:floess@mindspring.com]
Sent: Friday, May 25, 2007 12:40 PM
To: Ant Users List
Subject: Re: Javadocs with Generics
Ankush:
What does your call to <javadoc> look like?
I know that I am not doing anything special to ensure the generics
output correctly... For instance:
<javadoc sourcepath = "${jplate-build.JAVA_SRC_PATH}" classpath =
"${jplate-build.JAVA_CLASSES_HOME}" destdir =
"${jplate-build.JAVA_DOC_GENERATED_HOME}" packagenames =
"${jplate-build.JAVA_DOC_PACKAGE_NAMES}" author = "true" private =
"true" windowtitle = "${jplate-build.JAVA_PROJECT_NAME}" overview =
"${jplate-build.JAVA_DOC_OVERVIEW_FILE}"/>
I am not specifying any target attribute as I am currently using JDK
1.6.0 - but that shouldn't matter...
Silly question: are you sure your internal Javadocs (meaning in the
java source file) are correctly laid out? I know when I incorrectly
defined my generics, they didn't output at all...
Can we see a sample of your Java code?
Chadha, Ankush wrote:
> Hi All
>
> I am using javadoc (ant task) to generate javadoc of my source files.
> I have set the source and the ant's magic property for java and javac
> to
> 1.5 but still the generics are not included in the final javadoc.
> However if I generate the javadoc through my IDE, the generics are
> included.
>
> Any suggestions for the same?
>
> Best
> Ankush
>
>
--
Scot P. Floess
27 Lake Royale
Louisburg, NC 27549
252-478-8087 (Home)
919-392-6730 (Work)
Chief Architect JPlate http://sourceforge.net/projects/jplate
Chief Architect JavaPIM http://sourceforge.net/projects/javapim
---------------------------------------------------------------------
To unsubscribe, e-mail: user-unsubscribe@ant.apache.org For additional
commands, e-mail: user-help@ant.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: user-unsubscribe@ant.apache.org
For additional commands, e-mail: user-help@ant.apache.org
Re: Javadocs with Generics
Posted by "Scot P. Floess" <fl...@mindspring.com>.
Ankush:
What does your call to <javadoc> look like?
I know that I am not doing anything special to ensure the generics
output correctly... For instance:
<javadoc sourcepath = "${jplate-build.JAVA_SRC_PATH}" classpath =
"${jplate-build.JAVA_CLASSES_HOME}" destdir =
"${jplate-build.JAVA_DOC_GENERATED_HOME}" packagenames =
"${jplate-build.JAVA_DOC_PACKAGE_NAMES}" author = "true" private =
"true" windowtitle = "${jplate-build.JAVA_PROJECT_NAME}" overview =
"${jplate-build.JAVA_DOC_OVERVIEW_FILE}"/>
I am not specifying any target attribute as I am currently using JDK
1.6.0 - but that shouldn't matter...
Silly question: are you sure your internal Javadocs (meaning in the
java source file) are correctly laid out? I know when I incorrectly
defined my generics, they didn't output at all...
Can we see a sample of your Java code?
Chadha, Ankush wrote:
> Hi All
>
> I am using javadoc (ant task) to generate javadoc of my source files.
> I have set the source and the ant's magic property for java and javac to
> 1.5 but still the generics are not included in the final javadoc.
> However if I generate the javadoc through my IDE, the generics are
> included.
>
> Any suggestions for the same?
>
> Best
> Ankush
>
>
--
Scot P. Floess
27 Lake Royale
Louisburg, NC 27549
252-478-8087 (Home)
919-392-6730 (Work)
Chief Architect JPlate http://sourceforge.net/projects/jplate
Chief Architect JavaPIM http://sourceforge.net/projects/javapim
---------------------------------------------------------------------
To unsubscribe, e-mail: user-unsubscribe@ant.apache.org
For additional commands, e-mail: user-help@ant.apache.org