You are viewing a plain text version of this content. The canonical link for it is here.
Posted to user@ant.apache.org by Rick Hillegas <ri...@gmail.com> on 2018/06/02 15:49:18 UTC

generating module-aware javadoc with ant

I don't see any module attributes or nested elements documented for the 
<javadoc> task here: https://ant.apache.org/manual/Tasks/javadoc.html 
Googling around doesn't tease out any more information on how to 
generate module-aware javadoc with ant. I can generate module-aware 
javadoc by using the <exec> task.

I have a couple questions:

1) Am I just missing something basic?

2) Are module attributes and nested elements on the roadmap for a future 
ant version?

Thanks,

-Rick


---------------------------------------------------------------------
To unsubscribe, e-mail: user-unsubscribe@ant.apache.org
For additional commands, e-mail: user-help@ant.apache.org


Re: generating module-aware javadoc with ant

Posted by Stefan Bodewig <bo...@apache.org>.
On 2018-06-04, Rick Hillegas wrote:

> I have attached the tarball to the following ant/bugzilla issue:
> https://bz.apache.org/bugzilla/show_bug.cgi?id=62424

Thank you Rick

Stefan

---------------------------------------------------------------------
To unsubscribe, e-mail: user-unsubscribe@ant.apache.org
For additional commands, e-mail: user-help@ant.apache.org


Re: generating module-aware javadoc with ant

Posted by Rick Hillegas <ri...@gmail.com>.
Thanks, Jaikiran. I have attached the tarball to the following 
ant/bugzilla issue: https://bz.apache.org/bugzilla/show_bug.cgi?id=62424

Thanks,
-Rick

On 6/3/18 6:39 AM, Jaikiran Pai wrote:
> Hi Rick,
>
> On 02/06/18 11:23 PM, Rick Hillegas wrote:
>>  I have attached a little ant-based project to demonstrate my problem. 
> The attachment didn't come through and I don't remember if this 
> mailing list supports attachments. Can you include the build.xml 
> inline in your mail?Or if there's more than 1 file, then maybe create 
> a bugzilla and attach the files there?
>
> -Jaikiran
>
> ---------------------------------------------------------------------
> 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: generating module-aware javadoc with ant

Posted by Jaikiran Pai <ja...@gmail.com>.
Hi Rick,

On 02/06/18 11:23 PM, Rick Hillegas wrote:
>  I have attached a little ant-based project to demonstrate my problem. 
The attachment didn't come through and I don't remember if this mailing 
list supports attachments. Can you include the build.xml inline in your 
mail?Or if there's more than 1 file, then maybe create a bugzilla and 
attach the files there?

-Jaikiran

---------------------------------------------------------------------
To unsubscribe, e-mail: user-unsubscribe@ant.apache.org
For additional commands, e-mail: user-help@ant.apache.org


Re: generating module-aware javadoc with ant

Posted by Rick Hillegas <ri...@gmail.com>.
Thanks for responding so quickly, Stefan.

On 6/2/18 9:47 AM, Stefan Bodewig wrote:
> On 2018-06-02, Rick Hillegas wrote:
>
>> I don't see any module attributes or nested elements documented for
>> the <javadoc> task here:
>> https://ant.apache.org/manual/Tasks/javadoc.html Googling around
>> doesn't tease out any more information on how to generate module-aware
>> javadoc with ant.
> So far it seems it hasn't been missed by anybody.
>
>> I can generate module-aware javadoc by using the <exec> task.
> If you know how to do it with exec then you can use the nested <arg> of
> the <javadoc> task instead.
I have tried converting the <exec> call into a <javadoc> call by using 
nexted <arg> elements as you suggest. But no joy. I have attached a 
little ant-based project to demonstrate my problem. The "javadoc" target 
uses <exec>. The "javadoc2" target attempts but fails to use <javadoc>.
>
>> 2) Are module attributes and nested elements on the roadmap for a
>> future ant version?
> I must admit I haven't even looked at the javaodc changes for modules
> myself at all. Had a quick look right now.
>
> What do you think would be a good set of args to support?
>
> --expand-requires => attribute with values transitive/all
> --limit-modules => nested element
> --module => nested element
> --module-path => nested path element
> --module-source-path => nested path element
> --show-module-contents => attribute with api/all
>
> Do we need --add-modules and --upgrade-module-path at all? Even any of
> the "extended options"?
I'm afraid that I'm just at the beginning of understanding the 
module-related changes which were made to javadoc in JDK 9. The javadoc 
reference manual gives frustratingly terse descriptions of how the new 
switches behave. Very little additional information appears when when I 
google for examples of how to use these switches from the command line.

As you can see from the "javadoc" target in the attached tarball, 
--module and --module-source-path were enough to document a simple project.

Thanks,
-Rick
>
> Stefan
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: user-unsubscribe@ant.apache.org
> For additional commands, e-mail: user-help@ant.apache.org
>
>



Re: generating module-aware javadoc with ant

Posted by Stefan Bodewig <bo...@apache.org>.
On 2018-06-02, Rick Hillegas wrote:

> I don't see any module attributes or nested elements documented for
> the <javadoc> task here:
> https://ant.apache.org/manual/Tasks/javadoc.html Googling around
> doesn't tease out any more information on how to generate module-aware
> javadoc with ant.

So far it seems it hasn't been missed by anybody.

> I can generate module-aware javadoc by using the <exec> task.

If you know how to do it with exec then you can use the nested <arg> of
the <javadoc> task instead.

> 2) Are module attributes and nested elements on the roadmap for a
> future ant version?

I must admit I haven't even looked at the javaodc changes for modules
myself at all. Had a quick look right now.

What do you think would be a good set of args to support?

--expand-requires => attribute with values transitive/all
--limit-modules => nested element
--module => nested element
--module-path => nested path element
--module-source-path => nested path element
--show-module-contents => attribute with api/all

Do we need --add-modules and --upgrade-module-path at all? Even any of
the "extended options"?

Stefan

---------------------------------------------------------------------
To unsubscribe, e-mail: user-unsubscribe@ant.apache.org
For additional commands, e-mail: user-help@ant.apache.org