cancel
Showing results for 
Search instead for 
Did you mean: 

NWDS how to display Javadoc of an api added as dependencies?

Former Member
0 Kudos

I've created a new WebDynpro App. I've added the security dependencies to access the UME. Now I can use the Api in the Java Editor, but I don't get the description. What do I have to do to attach the source to get the Javadoc displayed.

Accepted Solutions (0)

Answers (3)

Answers (3)

Former Member
0 Kudos

This is really disappointing.

siarhei_pisarenka3
Active Contributor
0 Kudos

I think you can try to download the Javadocs by the link that I posted and store them in the file system. Then go to properties of the connected library and specify Javadoc location pointing to the file system.

BR, Siarhei

Former Member
0 Kudos

Yes thatu2019s what I do exactly when I use pure Eclipse with Open Source Frameworks. I hold the CTRL key and press with the mouse cursor on the method of which I like to see the Javadoc. If the Source is available the source file open. If not the .class file is opened and you get a list of methods. In this case you have at the upper right corner of your editor window a button u201CAttach Sourceu201D. This button I use to link the sources and get the Javadoc when hover a method with the mouse cursor. Unfortunately this button is not available in NWDS. Now my question is which steps are necessary to get the same in NWDS.

Best regards

Sebastian Lenk

Former Member
0 Kudos

The Answer I got from the OSS People:

Dear Customer,

Usually Eclipse stores JavaDoc and source information for jar libraries

in the .classpath file. If working with DC projects this is no longer

the case. As the dependency model of NWDI is handled internally these

dependencies do not appear in the .classpath file and hence cannot be

maintained by the usual Eclipse way of specifying them in the class

viewer.

If you look at a DC project in the Java perspective you will find DC

dependencies maintained under 'Required Development Components'. If you

try to add Javadoc location to any of these (by right clicking ->

Properties -> JavaDoc location) you will get the message that the

classpath does belong to container 'Required Development Components'

which does not allow user modifications.

Technically, you can always force the Developer Studio to show JavaDocs

by the following scheme:

1) Copy the jar where you want to add JavaDoc to another location (or

change it's name)

2) In the DC project where you want to see the JavaDoc go to the projectproperties -> Build Path -> Libraries and use 'add external jar' to add

the jar from the first step.

3) In the same view expand the newly added jar to see specification for

JavaDoc location. You can specify any location via the Edit button.

4) Change to the order tab and move the newly created jar to the top.

Now you should be able to see JavaDoc by hovering methods from this jar

in the Java Editor.

Unfortunately, there are a lot of downfalls with this approach so that Iwould not recommend to really do this:

1) By this approach many of the NWDI concepts are bypassed.

2) There is no tool support - you would have to add all jars manually

and remember to redo this if any of the original jars get updated.

3) You would probably run into build / deploy problems. The only 'clean'way would be to remove the additional jars from the project before

building or deploying (which of course would mean you have to specify

them all again later).

I understand the desire to have JavaDoc added to used DCs, but currentlyI don't see any way to do this in a clean way that fits to NWDI

paradigms. This would then be more of a feature request than a bug. As

far as I know this feature is planned to be included in a future release(not yet available to customers).

(Exact path specifications above were derived from a NWDS 7.11 and may

differ slightly if you have another version.)

Best Regards,

siarhei_pisarenka3
Active Contributor
0 Kudos

Hi Sebastian

Here you can find Javadocs for Security API (also includes UME API) for NW04s:

http://help.sap.com/javadocs/NW04S/current/se/index.html

I think the same links shall be available for other NW versions.

BR, Siarhei

Former Member
0 Kudos

Hi Siarhei,

Thanks for your answer. But unfortunately it doesnu2019t answers my question. Perhaps I was not precise enough.

I do not ask for the Javadoc of the UME API. I look for a way to get my NWDS configured, that it displays me the Javadoc of the API and the names of the parameters (not only .getUser( arg0, arg1)). In my case the api of com.sap.security.api.sda

Best regards

Sebastian Lenk

Former Member
0 Kudos

Hi Siarhei,

Thanks for your answer. But unfortunately it doesnu2019t answers my question. Perhaps I was not precise enough.

I do not ask for the Javadoc of the UME API. I look for a way to get my NWDS configured, that it displays me the Javadoc of the API and the names of the parameters (not only .getUser( arg0, arg1)). In my case the api of com.sap.security.api.sda

Best regards

Sebastian Lenk