Adding Javadoc containing 'element-list' for a library added to a project

[A S <ab...@gmail.com>]

Hello,

I am only sporadically using Netbeans for some small projects, so my
apologies if the question is too amateurish. I was previously using
Netbeans 8.2, and the platform I was working with was Java 8.

With a change to JDK 11 for the project, I switched up to Apache Netbeans
11.2. For one of the libraries that I am using for the project, when I try
to add the Javadoc to the library, Netbeans complains because no
package-list exist. I see that the JDK 11 version has an 'element-list' in
the javadoc folder with contents similar to the 'package-list' of JDK 8
version. If I copy the element-list and rename the file to package-list,
Netbeans seems to be able to add the Javadoc. However this only allows the
path to be added as javadoc, and the documentation isn't actually available
when referencing a method in the editor.

My google searches are quit inconclusive on whether there is a way to read
such a Javadoc from Netbeans. Does anyone have a concrete answer on whether
this is possible? If yes, how?

Best regards
Abhinav Sharma

Re: Adding Javadoc containing 'element-list' for a library added to a project

[A S <ab...@gmail.com>]

I realized that the JDK 11 online API is also not read correctly. In my
case this was also showing that no javadoc was found, until I did a small
hack.

So we can add it to the problem. Meanwhile I can share the hack I did to
get some of the Javadoc working.

Under Platforms, for JDK 11 the Javadoc source was set as
https://docs.oracle.com/en/java/javase/11/docs/api/
I added https://docs.oracle.com/en/java/javase/11/docs/api/java.base to the
top of the list. And at least in the pop-up documentation it is working for
me. Interestingly it is also working for other modules apart from
java.base.
I am not sure how exactly this works, and I am unable to find further
details easily.





On Fri, Nov 29, 2019 at 4:12 PM Richard Grin <Ri...@univ-cotedazur.fr>
wrote:

> Thanks Abhinav. I had not noticed this little icon "Show documentation in
> external web brower button".
>
> When I click on this button, I receive a "Page not found" error (404). Yet
> I have the good URL for the javadoc of the JDK 11 (as I see in the Java
> Platform Manager).
>
> I use NetBeans 11.2 without the "nb-javac Java editing support library".
>
> Richard
> Le 29/11/2019 à 15:00, A S a écrit :
>
> Hi Richard,
>
> I think it wasn't the correct name. What I called "Hint window" should be
> called "pop-up documentation window" which appears if you press Ctrl+Space
> while typing.
> You may also enable its appearance automatically under
> Tools->Options->Editor->Code Completion
>
> The behavior I reported about being able to see correct location in a
> browser is for the case where I have copied the elements-list to a file
> named packages-list in the Javadoc of the external library.
> The pop-up documentation window only shows the type definitions for the
> external library, but is otherwise empty. But I am guessing this is because
> the Javadoc is not in the format expected by Netbeans and I am merely
> hacking it with the renaming trick.
>
> Below is an example how it should look like. Here sourcing from online
> Javadoc for JDK11.
> [image: Netbeans_javadoc.png]
>
> Best regards
> Abhinav
>
>
> On Thu, Nov 28, 2019 at 11:33 PM Richard Grin <
> Richard.GRIN@univ-cotedazur.fr> wrote:
>
>> Hi Abhinav,
>>
>> What is this "hint window"? How do you open it?
>>
>> Richard
>> Le 28/11/2019 à 16:00, A S a écrit :
>>
>> One additional info: With Alt-F1(or context menu) or by clicking on the
>> "Show documentation in external web browser" button in the hint window, I
>> do land to the correct part of the documentation in the external browser.
>> Just that the documentation doesn't show up in the hint window in the
>> editor.
>>
>> On Thu, Nov 28, 2019 at 12:31 PM A S <ab...@gmail.com>
>> wrote:
>>
>>> Thanks for your response Emi! I haven't tried with any other libraries
>>> or any other JDK versions to try other Javadoc formats. To be frank I only
>>> got to know these two possibilities because of the issue here, and am not
>>> aware of any other formats.
>>>
>>> I am hoping some more experienced users have some insight here, and can
>>> guide/help me how in filing a bug if this is one.
>>>
>>> Regards
>>> Abhinav
>>>
>>>
>>> On Wed, Nov 27, 2019 at 6:40 PM Emilian Bold <em...@gmail.com>
>>> wrote:
>>>
>>>> This sounds like a NetBeans bug.
>>>>
>>>> In JDK 10, "element-list" was added to better support modules. So,
>>>> does NetBeans work with other modern Javadocs?
>>>>
>>>> Maybe there is something subtler: does a library in a JDK 8 project
>>>> display Javadoc 11-style documentation?
>>>>
>>>> --emi
>>>>
>>>> On Wed, Nov 27, 2019 at 4:45 PM A S <ab...@gmail.com>
>>>> wrote:
>>>> >
>>>> > Hello,
>>>> >
>>>> > I am only sporadically using Netbeans for some small projects, so my
>>>> apologies if the question is too amateurish. I was previously using
>>>> Netbeans 8.2, and the platform I was working with was Java 8.
>>>> >
>>>> > With a change to JDK 11 for the project, I switched up to Apache
>>>> Netbeans 11.2. For one of the libraries that I am using for the project,
>>>> when I try to add the Javadoc to the library, Netbeans complains because no
>>>> package-list exist. I see that the JDK 11 version has an 'element-list' in
>>>> the javadoc folder with contents similar to the 'package-list' of JDK 8
>>>> version. If I copy the element-list and rename the file to package-list,
>>>> Netbeans seems to be able to add the Javadoc. However this only allows the
>>>> path to be added as javadoc, and the documentation isn't actually available
>>>> when referencing a method in the editor.
>>>> >
>>>> > My google searches are quit inconclusive on whether there is a way to
>>>> read such a Javadoc from Netbeans. Does anyone have a concrete answer on
>>>> whether this is possible? If yes, how?
>>>> >
>>>> > Best regards
>>>> > Abhinav Sharma
>>>>
>>>

Re: Adding Javadoc containing 'element-list' for a library added to a project

[Richard Grin <Ri...@univ-cotedazur.fr>]

Thanks Abhinav. I had not noticed this little icon "Show documentation in external web brower button".

When I click on this button, I receive a "Page not found" error (404). Yet I have the good URL for the javadoc of the JDK 11 (as I see in the Java Platform Manager).

I use NetBeans 11.2 without the "nb-javac Java editing support library".

Richard

Le 29/11/2019 à 15:00, A S a écrit :
Hi Richard,

I think it wasn't the correct name. What I called "Hint window" should be called "pop-up documentation window" which appears if you press Ctrl+Space while typing.
You may also enable its appearance automatically under Tools->Options->Editor->Code Completion

The behavior I reported about being able to see correct location in a browser is for the case where I have copied the elements-list to a file named packages-list in the Javadoc of the external library.
The pop-up documentation window only shows the type definitions for the external library, but is otherwise empty. But I am guessing this is because the Javadoc is not in the format expected by Netbeans and I am merely hacking it with the renaming trick.

Below is an example how it should look like. Here sourcing from online Javadoc for JDK11.
[Netbeans_javadoc.png]

Best regards
Abhinav


On Thu, Nov 28, 2019 at 11:33 PM Richard Grin <Ri...@univ-cotedazur.fr>> wrote:

Hi Abhinav,

What is this "hint window"? How do you open it?

Richard

Le 28/11/2019 à 16:00, A S a écrit :
One additional info: With Alt-F1(or context menu) or by clicking on the "Show documentation in external web browser" button in the hint window, I do land to the correct part of the documentation in the external browser. Just that the documentation doesn't show up in the hint window in the editor.

On Thu, Nov 28, 2019 at 12:31 PM A S <ab...@gmail.com>> wrote:
Thanks for your response Emi! I haven't tried with any other libraries or any other JDK versions to try other Javadoc formats. To be frank I only got to know these two possibilities because of the issue here, and am not aware of any other formats.

I am hoping some more experienced users have some insight here, and can guide/help me how in filing a bug if this is one.

Regards
Abhinav


On Wed, Nov 27, 2019 at 6:40 PM Emilian Bold <em...@gmail.com>> wrote:
This sounds like a NetBeans bug.

In JDK 10, "element-list" was added to better support modules. So,
does NetBeans work with other modern Javadocs?

Maybe there is something subtler: does a library in a JDK 8 project
display Javadoc 11-style documentation?

--emi

On Wed, Nov 27, 2019 at 4:45 PM A S <ab...@gmail.com>> wrote:
>
> Hello,
>
> I am only sporadically using Netbeans for some small projects, so my apologies if the question is too amateurish. I was previously using Netbeans 8.2, and the platform I was working with was Java 8.
>
> With a change to JDK 11 for the project, I switched up to Apache Netbeans 11.2. For one of the libraries that I am using for the project, when I try to add the Javadoc to the library, Netbeans complains because no package-list exist. I see that the JDK 11 version has an 'element-list' in the javadoc folder with contents similar to the 'package-list' of JDK 8 version. If I copy the element-list and rename the file to package-list, Netbeans seems to be able to add the Javadoc. However this only allows the path to be added as javadoc, and the documentation isn't actually available when referencing a method in the editor.
>
> My google searches are quit inconclusive on whether there is a way to read such a Javadoc from Netbeans. Does anyone have a concrete answer on whether this is possible? If yes, how?
>
> Best regards
> Abhinav Sharma

Re: Adding Javadoc containing 'element-list' for a library added to a project

[A S <ab...@gmail.com>]

Hi Richard,

I think it wasn't the correct name. What I called "Hint window" should be
called "pop-up documentation window" which appears if you press Ctrl+Space
while typing.
You may also enable its appearance automatically under
Tools->Options->Editor->Code Completion

The behavior I reported about being able to see correct location in a
browser is for the case where I have copied the elements-list to a file
named packages-list in the Javadoc of the external library.
The pop-up documentation window only shows the type definitions for the
external library, but is otherwise empty. But I am guessing this is because
the Javadoc is not in the format expected by Netbeans and I am merely
hacking it with the renaming trick.

Below is an example how it should look like. Here sourcing from online
Javadoc for JDK11.
[image: Netbeans_javadoc.png]

Best regards
Abhinav


On Thu, Nov 28, 2019 at 11:33 PM Richard Grin <
Richard.GRIN@univ-cotedazur.fr> wrote:

> Hi Abhinav,
>
> What is this "hint window"? How do you open it?
>
> Richard
> Le 28/11/2019 à 16:00, A S a écrit :
>
> One additional info: With Alt-F1(or context menu) or by clicking on the
> "Show documentation in external web browser" button in the hint window, I
> do land to the correct part of the documentation in the external browser.
> Just that the documentation doesn't show up in the hint window in the
> editor.
>
> On Thu, Nov 28, 2019 at 12:31 PM A S <ab...@gmail.com>
> wrote:
>
>> Thanks for your response Emi! I haven't tried with any other libraries or
>> any other JDK versions to try other Javadoc formats. To be frank I only got
>> to know these two possibilities because of the issue here, and am not aware
>> of any other formats.
>>
>> I am hoping some more experienced users have some insight here, and can
>> guide/help me how in filing a bug if this is one.
>>
>> Regards
>> Abhinav
>>
>>
>> On Wed, Nov 27, 2019 at 6:40 PM Emilian Bold <em...@gmail.com>
>> wrote:
>>
>>> This sounds like a NetBeans bug.
>>>
>>> In JDK 10, "element-list" was added to better support modules. So,
>>> does NetBeans work with other modern Javadocs?
>>>
>>> Maybe there is something subtler: does a library in a JDK 8 project
>>> display Javadoc 11-style documentation?
>>>
>>> --emi
>>>
>>> On Wed, Nov 27, 2019 at 4:45 PM A S <ab...@gmail.com>
>>> wrote:
>>> >
>>> > Hello,
>>> >
>>> > I am only sporadically using Netbeans for some small projects, so my
>>> apologies if the question is too amateurish. I was previously using
>>> Netbeans 8.2, and the platform I was working with was Java 8.
>>> >
>>> > With a change to JDK 11 for the project, I switched up to Apache
>>> Netbeans 11.2. For one of the libraries that I am using for the project,
>>> when I try to add the Javadoc to the library, Netbeans complains because no
>>> package-list exist. I see that the JDK 11 version has an 'element-list' in
>>> the javadoc folder with contents similar to the 'package-list' of JDK 8
>>> version. If I copy the element-list and rename the file to package-list,
>>> Netbeans seems to be able to add the Javadoc. However this only allows the
>>> path to be added as javadoc, and the documentation isn't actually available
>>> when referencing a method in the editor.
>>> >
>>> > My google searches are quit inconclusive on whether there is a way to
>>> read such a Javadoc from Netbeans. Does anyone have a concrete answer on
>>> whether this is possible? If yes, how?
>>> >
>>> > Best regards
>>> > Abhinav Sharma
>>>
>>

Re: Adding Javadoc containing 'element-list' for a library added to a project

[Richard Grin <Ri...@univ-cotedazur.fr>]

Hi Abhinav,

What is this "hint window"? How do you open it?

Richard

Le 28/11/2019 à 16:00, A S a écrit :
One additional info: With Alt-F1(or context menu) or by clicking on the "Show documentation in external web browser" button in the hint window, I do land to the correct part of the documentation in the external browser. Just that the documentation doesn't show up in the hint window in the editor.

On Thu, Nov 28, 2019 at 12:31 PM A S <ab...@gmail.com>> wrote:
Thanks for your response Emi! I haven't tried with any other libraries or any other JDK versions to try other Javadoc formats. To be frank I only got to know these two possibilities because of the issue here, and am not aware of any other formats.

I am hoping some more experienced users have some insight here, and can guide/help me how in filing a bug if this is one.

Regards
Abhinav


On Wed, Nov 27, 2019 at 6:40 PM Emilian Bold <em...@gmail.com>> wrote:
This sounds like a NetBeans bug.

In JDK 10, "element-list" was added to better support modules. So,
does NetBeans work with other modern Javadocs?

Maybe there is something subtler: does a library in a JDK 8 project
display Javadoc 11-style documentation?

--emi

On Wed, Nov 27, 2019 at 4:45 PM A S <ab...@gmail.com>> wrote:
>
> Hello,
>
> I am only sporadically using Netbeans for some small projects, so my apologies if the question is too amateurish. I was previously using Netbeans 8.2, and the platform I was working with was Java 8.
>
> With a change to JDK 11 for the project, I switched up to Apache Netbeans 11.2. For one of the libraries that I am using for the project, when I try to add the Javadoc to the library, Netbeans complains because no package-list exist. I see that the JDK 11 version has an 'element-list' in the javadoc folder with contents similar to the 'package-list' of JDK 8 version. If I copy the element-list and rename the file to package-list, Netbeans seems to be able to add the Javadoc. However this only allows the path to be added as javadoc, and the documentation isn't actually available when referencing a method in the editor.
>
> My google searches are quit inconclusive on whether there is a way to read such a Javadoc from Netbeans. Does anyone have a concrete answer on whether this is possible? If yes, how?
>
> Best regards
> Abhinav Sharma

Re: Adding Javadoc containing 'element-list' for a library added to a project

[A S <ab...@gmail.com>]

One additional info: With Alt-F1(or context menu) or by clicking on the
"Show documentation in external web browser" button in the hint window, I
do land to the correct part of the documentation in the external browser.
Just that the documentation doesn't show up in the hint window in the
editor.

On Thu, Nov 28, 2019 at 12:31 PM A S <ab...@gmail.com> wrote:

> Thanks for your response Emi! I haven't tried with any other libraries or
> any other JDK versions to try other Javadoc formats. To be frank I only got
> to know these two possibilities because of the issue here, and am not aware
> of any other formats.
>
> I am hoping some more experienced users have some insight here, and can
> guide/help me how in filing a bug if this is one.
>
> Regards
> Abhinav
>
>
> On Wed, Nov 27, 2019 at 6:40 PM Emilian Bold <em...@gmail.com>
> wrote:
>
>> This sounds like a NetBeans bug.
>>
>> In JDK 10, "element-list" was added to better support modules. So,
>> does NetBeans work with other modern Javadocs?
>>
>> Maybe there is something subtler: does a library in a JDK 8 project
>> display Javadoc 11-style documentation?
>>
>> --emi
>>
>> On Wed, Nov 27, 2019 at 4:45 PM A S <ab...@gmail.com>
>> wrote:
>> >
>> > Hello,
>> >
>> > I am only sporadically using Netbeans for some small projects, so my
>> apologies if the question is too amateurish. I was previously using
>> Netbeans 8.2, and the platform I was working with was Java 8.
>> >
>> > With a change to JDK 11 for the project, I switched up to Apache
>> Netbeans 11.2. For one of the libraries that I am using for the project,
>> when I try to add the Javadoc to the library, Netbeans complains because no
>> package-list exist. I see that the JDK 11 version has an 'element-list' in
>> the javadoc folder with contents similar to the 'package-list' of JDK 8
>> version. If I copy the element-list and rename the file to package-list,
>> Netbeans seems to be able to add the Javadoc. However this only allows the
>> path to be added as javadoc, and the documentation isn't actually available
>> when referencing a method in the editor.
>> >
>> > My google searches are quit inconclusive on whether there is a way to
>> read such a Javadoc from Netbeans. Does anyone have a concrete answer on
>> whether this is possible? If yes, how?
>> >
>> > Best regards
>> > Abhinav Sharma
>>
>

Re: Adding Javadoc containing 'element-list' for a library added to a project

[A S <ab...@gmail.com>]

Thanks for your response Emi! I haven't tried with any other libraries or
any other JDK versions to try other Javadoc formats. To be frank I only got
to know these two possibilities because of the issue here, and am not aware
of any other formats.

I am hoping some more experienced users have some insight here, and can
guide/help me how in filing a bug if this is one.

Regards
Abhinav


On Wed, Nov 27, 2019 at 6:40 PM Emilian Bold <em...@gmail.com> wrote:

> This sounds like a NetBeans bug.
>
> In JDK 10, "element-list" was added to better support modules. So,
> does NetBeans work with other modern Javadocs?
>
> Maybe there is something subtler: does a library in a JDK 8 project
> display Javadoc 11-style documentation?
>
> --emi
>
> On Wed, Nov 27, 2019 at 4:45 PM A S <ab...@gmail.com> wrote:
> >
> > Hello,
> >
> > I am only sporadically using Netbeans for some small projects, so my
> apologies if the question is too amateurish. I was previously using
> Netbeans 8.2, and the platform I was working with was Java 8.
> >
> > With a change to JDK 11 for the project, I switched up to Apache
> Netbeans 11.2. For one of the libraries that I am using for the project,
> when I try to add the Javadoc to the library, Netbeans complains because no
> package-list exist. I see that the JDK 11 version has an 'element-list' in
> the javadoc folder with contents similar to the 'package-list' of JDK 8
> version. If I copy the element-list and rename the file to package-list,
> Netbeans seems to be able to add the Javadoc. However this only allows the
> path to be added as javadoc, and the documentation isn't actually available
> when referencing a method in the editor.
> >
> > My google searches are quit inconclusive on whether there is a way to
> read such a Javadoc from Netbeans. Does anyone have a concrete answer on
> whether this is possible? If yes, how?
> >
> > Best regards
> > Abhinav Sharma
>

Re: Adding Javadoc containing 'element-list' for a library added to a project

[Emilian Bold <em...@gmail.com>]

This sounds like a NetBeans bug.

In JDK 10, "element-list" was added to better support modules. So,
does NetBeans work with other modern Javadocs?

Maybe there is something subtler: does a library in a JDK 8 project
display Javadoc 11-style documentation?

--emi

On Wed, Nov 27, 2019 at 4:45 PM A S <ab...@gmail.com> wrote:
>
> Hello,
>
> I am only sporadically using Netbeans for some small projects, so my apologies if the question is too amateurish. I was previously using Netbeans 8.2, and the platform I was working with was Java 8.
>
> With a change to JDK 11 for the project, I switched up to Apache Netbeans 11.2. For one of the libraries that I am using for the project, when I try to add the Javadoc to the library, Netbeans complains because no package-list exist. I see that the JDK 11 version has an 'element-list' in the javadoc folder with contents similar to the 'package-list' of JDK 8 version. If I copy the element-list and rename the file to package-list, Netbeans seems to be able to add the Javadoc. However this only allows the path to be added as javadoc, and the documentation isn't actually available when referencing a method in the editor.
>
> My google searches are quit inconclusive on whether there is a way to read such a Javadoc from Netbeans. Does anyone have a concrete answer on whether this is possible? If yes, how?
>
> Best regards
> Abhinav Sharma

---------------------------------------------------------------------
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