msgraph-sdk-java icon indicating copy to clipboard operation
msgraph-sdk-java copied to clipboard

JavaDoc has to be modified manually to map to its corresponding classes

Open coinzz opened this issue 1 year ago • 2 comments

Expected behavior

JavDoc should be readable in IDE simply after downloading it.

Actual behavior

JavDoc package structure has to be modified manually, since the paths do not match: Code package path: com.microsoft.graph.* JavaDoc package path: com.microsoft.graph.generated.*

After moving all contents in the sources jar from generated one folder up, the IDE is able to map the JavaDoc to it's corresponding classes.

Steps to reproduce the behavior

Download current version of graph 6.4.0 and its corresponding sources.

coinzz avatar Mar 20 '24 08:03 coinzz

@coinzz Thanks for using the java SDK and for reporting this @ramsessanchez FYI this is why I was a bit uncomfortable when you suggested moving the generated stuff to a dedicated directory without updating the package name. Couldn't remember the rationale, but I somehow remembered it'd break something. @Ndiritu whenever you have some time, here are the steps to take:

  1. update the weekly generation cleanup script to delete what's in src/main/java/com/microsoft/graph excluding info and serviceclient.
  2. update the weekly generation path to stop appending a "generated" segment.
  3. kick-off a generation.
  4. make sure the generated directory is deleted from PR.

(let me know if you have questions)

baywet avatar Mar 20 '24 11:03 baywet

Without JavaDoc and sources it is really hard to work with the SDK. The problem still exists in version 6.13.0.

image

poschi3 avatar Jul 30 '24 10:07 poschi3

Issue mentioned by @poschi3 still exists in version 6-25.1

faisalferoz avatar Jan 21 '25 16:01 faisalferoz

This is still broken in latest versions for source jars (both in v1.0 and beta versions), the sources are in the generated folder.

Image

clementdenis avatar Nov 10 '25 11:11 clementdenis

Hey @clementdenis in the meantime this was working, but I noticed this as well, since it suddenly stopped working again. Therefore I already created a new issue for that: #2416 Unfortunately it seems that there are no interactions from any dev in this project to any issues since january 😯

coinzz avatar Nov 11 '25 09:11 coinzz