Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

JavaDoc jar shipped with the SDK is empty #2078

Open
Ndiritu opened this issue Jul 11, 2024 · 1 comment
Open

JavaDoc jar shipped with the SDK is empty #2078

Ndiritu opened this issue Jul 11, 2024 · 1 comment
Labels
area:documentation Focused on documentation of the product type:bug A broken experience

Comments

@Ndiritu
Copy link
Contributor

Ndiritu commented Jul 11, 2024

Describe the bug

Empty JavaDoc JAR is hinders set-up time with the SDK.

What's missing from this upgrade guide is a link to any v6 JavaDocs. The javadoc jar on Maven Central is empty, nothing but a META-INF directory. Ditto for all the other v6 versions I checked. I'm trying to upgrade a v5 app and frustrated by the lack of JavaDocs. In particular, I'm stumbling around trying to find the import and API for classes like PageIterator, RequestConfiguration , etc. If you won't provide JavaDocs, then at least show the imports in your examples.

Originally posted by @johnthad in #2070 (comment)

Expected behavior

JavaDoc Jar to contain relevant docs

How to reproduce

,

SDK Version

6.x

Latest version known to work for scenario above?

No response

Known Workarounds

No response

Debug output

Click to expand log ```
</details>


### Configuration

_No response_

### Other information

_No response_
@Ndiritu Ndiritu added status:waiting-for-triage An issue that is yet to be reviewed or assigned type:bug A broken experience area:documentation Focused on documentation of the product and removed status:waiting-for-triage An issue that is yet to be reviewed or assigned labels Jul 11, 2024
@dias717
Copy link

dias717 commented Nov 14, 2024

@Ndiritu,

I agree with you. The JavaDoc does not work in Intellij. The reason is that the *-javadoc.jar file has only one manifest file in it. The other libraries in the *-javadoc.jar archive contain many files and weigh several megabytes. If I do the following workaround, then JavaDoc works in Intellij. Microsoft should do something similar and provide us with a working JavaDoc!

WORKAROUND TO USE THE JAVA DOC FOR MS GRAPH 6 in Intellij on Windows 10

GENERATE JAVA-DOC:

javadoc -d /c/Users/MY-USER-NAME/microsoft-graph-docs \
-sourcepath /c/Users/MY-USER-NAME/microsoft-graph-sources \
-subpackages com.microsoft.graph \
-classpath "/c/Users/MY-USER-NAME/.m2/repository/com/microsoft/kiota/microsoft-kiota-abstractions/1.7.0/microsoft-kiota-abstractions-1.7.0.jar:/c/Users/MY-USER-NAME/.m2/repository/com/microsoft/kiota/microsoft-kiota-serialization-json/1.7.0/microsoft-kiota-serialization-json-1.7.0.jar:/c/Users/MY-USER-NAME/.m2/repository/com/microsoft/kiota/microsoft-kiota-serialization-form/1.7.0/microsoft-kiota-serialization-form-1.7.0.jar:/c/Users/MY-USER-NAME/.m2/repository/com/microsoft/kiota/microsoft-kiota-serialization-multipart/1.7.0/microsoft-kiota-serialization-multipart-1.7.0.jar:/c/Users/MY-USER-NAME/.m2/repository/com/microsoft/kiota/microsoft-kiota-serialization-text/1.7.0/microsoft-kiota-serialization-text-1.7.0.jar:/c/Users/MY-USER-NAME/.m2/repository/jakarta/annotation/jakarta.annotation-api/3.0.0/jakarta.annotation-api-3.0.0.jar:/c/Users/MY-USER-NAME/.m2/repository/com/squareup/okhttp3/okhttp/4.12.0/okhttp-4.12.0.jar:/c/Users/MY-USER-NAME/.m2/repository/com/azure/azure-core/1.52.0/azure-core-1.52.0.jar:/c/Users/MY-USER-NAME/.m2/repository/com/microsoft/graph/microsoft-graph-core/3.3.1/microsoft-graph-core-3.3.1.jar"

PACK THE GENERATED DATA INTO JAR:

cd /c/Users/MY-USER-NAME/microsoft-graph-docs

jar cf microsoft-graph-6.20.0-javadoc.jar *

COPY THE JAR INTO MS GRAPH FOLDER:

cp -f /c/Users/MY-USER-NAME/microsoft-graph-docs/microsoft-graph-6.20.0-javadoc.jar /c/Users/MY-USER-NAME/.m2/repository/com/microsoft/graph/microsoft-graph/6.20.0/

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area:documentation Focused on documentation of the product type:bug A broken experience
Projects
None yet
Development

No branches or pull requests

2 participants