You are viewing a plain text version of this content. The canonical link for it is here.
Posted to users@netbeans.apache.org by Glenn Holmer <ce...@kolabnow.com.INVALID> on 2021/02/20 17:49:44 UTC

Javadoc generation from within NetBeans

Is anybody else having trouble getting NetBeans to generate Javadoc? 
I've got a modular project (source level 11) that builds and runs 
successfully (other programs can call into it by declaring the module), 
but when I click "Generate Javadoc" from the project menu, I get

"Exit code: 1 - error: module not found: org.lyonlabs.d64"

That's the module name of the project itself. I made sure to be using 
the latest maven-javadoc-plugin (3.2.0), with source set to 11. I get 
the same result with "mvn javadoc:javadoc" from the command line. If I 
change the POM for maven-javadoc-plugin to <source>8</source>, I get 
beautiful and complete Javadoc, although of course without any module 
information.

-- 
Glenn Holmer (Linux registered user #16682)
"After the vintage season came the aftermath -- and Cenbe."



Re: Javadoc generation from within NetBeans

Posted by Bradley Willcott <op...@gmail.com>.
Might I suggest you try setting it to: "compiler:compile javadoc:javadoc"?

If it solves the problem, then maybe the Netbeans versions you are 
referring to need to have their defaults changed.

However, for my NB 12.1 on Linux, this is the default.

Brad.

On 23/2/21 12:15 am, Richard Grin wrote:
>
> With NetBeans 12.1 (Windows 10), it's "generate-sources 
> javadoc:javadoc" too and not "compiler:compile javadoc:javadoc".
>
> Richard
>
> Le 22/02/2021 à 16:07, Glenn Holmer a écrit :
>> On 2/21/21 9:24 PM, Bradley Willcott wrote:
>>> I am using NB 12.1 on Linux.
>>>
>>> When I right right-click on a project, then "Properties" -> 
>>> "Actions" : "Generate Javadoc", I get this under 'Execute Goals:' 
>>> "compiler:compile javadoc:javadoc".
>>
>> In a new project (using 12.3-beta3), I get "generate-sources 
>> javadoc:javadoc". Same if I install fresh with a clean userdir.
>>
>>> I have no problems using the Generate Javadoc menu option on the 
>>> project right-click menu.
>>
>> With a modular project and source set to >= 9?
>>
>> <plugin>
>>      <groupId>org.apache.maven.plugins</groupId>
>>      <artifactId>maven-javadoc-plugin</artifactId>
>>      <version>3.2.0</version>
>>      <configuration>
>>        <source>11</source>
>>        <detectJavaApiLink>false</detectJavaApiLink>
>> <excludePackageNames>org.apache.logging.*</excludePackageNames>
>>      </configuration>
>> </plugin>
>>
>>> Oh, by the way, this is the default setting :)
>>
>> Not what I'm seeing (unless it's changed since 12.1).
>>
>>
>> ---------------------------------------------------------------------
>> To unsubscribe, e-mail:users-unsubscribe@netbeans.apache.org
>> For additional commands, e-mail:users-help@netbeans.apache.org
>>
>> For further information about the NetBeans mailing lists, visit:
>> https://cwiki.apache.org/confluence/display/NETBEANS/Mailing+lists

Re: Javadoc generation from within NetBeans

Posted by Richard Grin <Ri...@univ-cotedazur.fr>.
With NetBeans 12.1 (Windows 10), it's "generate-sources javadoc:javadoc" 
too and not "compiler:compile javadoc:javadoc".

Richard

Le 22/02/2021 à 16:07, Glenn Holmer a écrit :
> On 2/21/21 9:24 PM, Bradley Willcott wrote:
>> I am using NB 12.1 on Linux.
>>
>> When I right right-click on a project, then "Properties" -> "Actions" 
>> : "Generate Javadoc", I get this under 'Execute Goals:' 
>> "compiler:compile javadoc:javadoc".
>
> In a new project (using 12.3-beta3), I get "generate-sources 
> javadoc:javadoc". Same if I install fresh with a clean userdir.
>
>> I have no problems using the Generate Javadoc menu option on the 
>> project right-click menu.
>
> With a modular project and source set to >= 9?
>
> <plugin>
>      <groupId>org.apache.maven.plugins</groupId>
>      <artifactId>maven-javadoc-plugin</artifactId>
>      <version>3.2.0</version>
>      <configuration>
>        <source>11</source>
>        <detectJavaApiLink>false</detectJavaApiLink>
> <excludePackageNames>org.apache.logging.*</excludePackageNames>
>      </configuration>
> </plugin>
>
>> Oh, by the way, this is the default setting :)
>
> Not what I'm seeing (unless it's changed since 12.1).
>
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: users-unsubscribe@netbeans.apache.org
> For additional commands, e-mail: users-help@netbeans.apache.org
>
> For further information about the NetBeans mailing lists, visit:
> https://cwiki.apache.org/confluence/display/NETBEANS/Mailing+lists

Re: Javadoc generation from within NetBeans

Posted by Glenn Holmer <ce...@kolabnow.com.INVALID>.
On 2/21/21 9:24 PM, Bradley Willcott wrote:
> I am using NB 12.1 on Linux.
> 
> When I right right-click on a project, then "Properties" -> "Actions" : 
> "Generate Javadoc", I get this under 'Execute Goals:' "compiler:compile 
> javadoc:javadoc".

In a new project (using 12.3-beta3), I get "generate-sources 
javadoc:javadoc". Same if I install fresh with a clean userdir.

> I have no problems using the Generate Javadoc menu option on the project 
> right-click menu.

With a modular project and source set to >= 9?

<plugin>
      <groupId>org.apache.maven.plugins</groupId>
      <artifactId>maven-javadoc-plugin</artifactId>
      <version>3.2.0</version>
      <configuration>
        <source>11</source>
        <detectJavaApiLink>false</detectJavaApiLink>
        <excludePackageNames>org.apache.logging.*</excludePackageNames>
      </configuration>
</plugin>

> Oh, by the way, this is the default setting :)

Not what I'm seeing (unless it's changed since 12.1).

-- 
Glenn Holmer (Linux registered user #16682)
"After the vintage season came the aftermath -- and Cenbe."







Re: Javadoc generation from within NetBeans

Posted by Bradley Willcott <op...@gmail.com>.
Hi Glenn,

I am using NB 12.1 on Linux.

When I right right-click on a project, then "Properties" -> "Actions" : 
"Generate Javadoc", I get this under 'Execute Goals:' "compiler:compile 
javadoc:javadoc".

I have no problems using the Generate Javadoc menu option on the project 
right-click menu.

Oh, by the way, this is the default setting :)

Regards,
Brad.

On 21/2/21 8:05 am, Chris Marusich wrote:
> Hi Glenn,
>
> Glenn Holmer<ce...@kolabnow.com.INVALID>  writes:
>
>> Is anybody else having trouble getting NetBeans to generate Javadoc?
>> I've got a modular project (source level 11) that builds and runs
>> successfully (other programs can call into it by declaring the
>> module), but when I click "Generate Javadoc" from the project menu, I
>> get
>>
>> "Exit code: 1 - error: module not found: org.lyonlabs.d64"
>>
>> That's the module name of the project itself. I made sure to be using
>> the latest maven-javadoc-plugin (3.2.0), with source set to 11. I get
>> the same result with "mvn javadoc:javadoc" from the command line. If I
>> change the POM for maven-javadoc-plugin to <source>8</source>, I get
>> beautiful and complete Javadoc, although of course without any module
>> information.
> See:
>
>    https://issues.apache.org/jira/projects/MJAVADOC/summary
>
> "Maven Javadoc Plugin
>
> NOTE: when working with the Java Platform Modular System, be aware that
> the javadoc tool requires the compiled code, hence try to run mvn
> compile javadoc:javadoc before filing an issue."
>
> I.e., try running this explicitly: mvn compile javadoc:javadoc
>
> Seems like NetBeans ought to do this for you when you ask it to build
> Javadocs, but for some reason it doesn't.  You have to invoke Maven
> explicitly (which you can do from the IDE), and you have to say "mvn
> compile javadoc:javadoc".  Just "mvn javadoc:javadoc" is not enough.
>
> -- Chris

Re: Javadoc generation from within NetBeans

Posted by Glenn Holmer <ce...@kolabnow.com.INVALID>.
On 2/20/21 6:05 PM, Chris Marusich wrote:
> Glenn Holmer <ce...@kolabnow.com.INVALID> writes:
>> Is anybody else having trouble getting NetBeans to generate Javadoc?
>> I've got a modular project (source level 11) that builds and runs
>> successfully (other programs can call into it by declaring the
>> module), but when I click "Generate Javadoc" from the project menu, I
>> get
>>
>> "Exit code: 1 - error: module not found: org.lyonlabs.d64"

> NOTE: when working with the Java Platform Modular System, be aware that
> the javadoc tool requires the compiled code, hence try to run mvn
> compile javadoc:javadoc before filing an issue."
> 
> I.e., try running this explicitly: mvn compile javadoc:javadoc
> 
> Seems like NetBeans ought to do this for you when you ask it to build
> Javadocs, but for some reason it doesn't.

Thanx, that works. I set it up so I could just right-click the project 
and select "Run Maven --> Javadoc". Another mystery solved; this goes on 
my NetBeans cheat sheet!

-- 
Glenn Holmer (Linux registered user #16682)
"After the vintage season came the aftermath -- and Cenbe."

Re: Javadoc generation from within NetBeans

Posted by Chris Marusich <cm...@gmail.com>.
Hi Glenn,

Glenn Holmer <ce...@kolabnow.com.INVALID> writes:

> Is anybody else having trouble getting NetBeans to generate Javadoc?
> I've got a modular project (source level 11) that builds and runs
> successfully (other programs can call into it by declaring the
> module), but when I click "Generate Javadoc" from the project menu, I
> get
>
> "Exit code: 1 - error: module not found: org.lyonlabs.d64"
>
> That's the module name of the project itself. I made sure to be using
> the latest maven-javadoc-plugin (3.2.0), with source set to 11. I get
> the same result with "mvn javadoc:javadoc" from the command line. If I
> change the POM for maven-javadoc-plugin to <source>8</source>, I get
> beautiful and complete Javadoc, although of course without any module
> information.

See:

  https://issues.apache.org/jira/projects/MJAVADOC/summary

"Maven Javadoc Plugin

NOTE: when working with the Java Platform Modular System, be aware that
the javadoc tool requires the compiled code, hence try to run mvn
compile javadoc:javadoc before filing an issue."

I.e., try running this explicitly: mvn compile javadoc:javadoc

Seems like NetBeans ought to do this for you when you ask it to build
Javadocs, but for some reason it doesn't.  You have to invoke Maven
explicitly (which you can do from the IDE), and you have to say "mvn
compile javadoc:javadoc".  Just "mvn javadoc:javadoc" is not enough.

-- 
Chris