[QUERY] Javadoc location for 'javadoc' process to link Azure classes

[anumalasri]

Query/Question
What's javadoc URL for Azure Java SDK, which supports project javadoc links? For ex: https://docs.spring.io/spring-framework/docs/current/javadoc-api/

To link azure java sdk from other places, we need an URL where javadoc process can access and link azure java classes.

We tried link https://learn.microsoft.com/en-us/java/api/ but its throwing error in javadoc process

[ERROR] error: Error fetching URL: https://learn.microsoft.com/en-us/java/api/ (java.io.FileNotFoundException: https://learn.microsoft.com/en-us/java/api/package-list)

Why is this not a Bug or a feature Request?
A clear explanation of why is this not a bug or a feature request? - its not an issue with codebase, but a process and location where javadocs available.

Setup (please complete the following information if applicable):

• OS: Any
• IDE: Any
• Library/Libraries: All

Information Checklist
Kindly make sure that you have added all the following information above and checkoff the required fields otherwise we will treat the issuer as an incomplete report

• [X ] Query Added
• Setup information Added

[JonathanGiles]

Hi @anumalasri - I'd love to understand your use case a little bit more. Where are you going to set this URL? Does it need to be a hosted URL such as the example you provide, or can you use the javadoc jar file for each library, hosted on Maven Central? I am guessing your use case is to link to this URL within your Maven pom, so that API references can link to the Azure SDK for Java APIs? If so, do you have a project that you can point me to of yours that needs this? Thanks!

One of the problems I can see with this request off the bat is that we don't have a single aggregate JavaDoc for all libraries - each library is distinct. If this use case needs to be supported, we will possibly need to look into publishing an aggregate JavaDoc as well.

[anumalasri]

@JonathanGiles

We would like to link Azure sdk javadocs using maven plugin, as described here.

https://maven.apache.org/plugins/maven-javadoc-plugin/examples/links-configuration.html

This helps to cross link javadocs from one project to other.

 <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-javadoc-plugin</artifactId>
        <version>3.6.0</version>
        <configuration>
          <links>
            <link>http://commons.apache.org/dbcp/apidocs/</link>
            <link>http://commons.apache.org/fileupload/apidocs/</link>
          </links>
            ...
        </configuration>
      </plugin>

[JonathanGiles]

@anumalasri Thanks - that was what I was expecting you to say. It's a good question that you have, and we don't have a good answer right now, as we build our libraries individually, so there isn't a single JavaDoc that contains all JavaDoc in an aggregate fashion (that is published anywhere). I'll look into what we can do, but it won't be a quick answer unfortunately.

[anumalasri]

@JonathanGiles ..
when individual libraries are built, do they publish JavaDoc at some place. Do you have JavaDoc URLs for these individual libraries? I can pick a handful that we are using and test them out.