Page 1 of 1

Showing javadocs to Oxygen SDK-API in an IDE

Posted: Sat Jan 09, 2021 11:29 pm
by jakubsimek
Hi,

Is there a way of integrating the Javadocs of the Oxygen SDK-API to be shown in an IDE like Eclipse or IntelliJ?

I watched a Youtube video from one of your presentations ("Workshop: oXygen Plugins Development presented by Alex Jitianu at oXygen Users Meetup", https://youtu.be/23YSwgxyX-c) and I found it great how all the Javadocs of the classes and methods of your SDK were shown while typing the code in Eclipse.

If I understand it right the Javadocs are not included in the JARs which are downloaded while using the Maven dependencies of the SDK.

It would be very helpful while learning the API to have the Javadocs integrated in the IDE. Is it somehow possible to achieve this with the Oxygen SDK-API?

Many thanks in advance,
Jakub Šimek

Re: Showing javadocs to Oxygen SDK-API in an IDE

Posted: Mon Jan 11, 2021 10:43 am
by alex_jitianu
Hello,

We bundle both the SDK source code and the Javadoc as Maven artifacts published in the Maven repository. Please make sure that Eclipse is configured to download them by looking into Preferences:
image.png
image.png (33.84 KiB) Viewed 1509 times
and I see that IntelliJ has similar options too.

Best regards,
Alex

Re: Showing javadocs to Oxygen SDK-API in an IDE

Posted: Mon Jan 11, 2021 9:01 pm
by jakubsimek
It works perfectly, thank your very much for the hint!
Jakub

Re: Showing javadocs to Oxygen SDK-API in an IDE

Posted: Thu May 06, 2021 10:04 am
by kirkilj
Does anyone know if VS-Code supports this capability, either built-in or through an extension?