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

Import Java package-level documentation #776

Open
jonpryor opened this issue Jan 11, 2021 · 0 comments
Open

Import Java package-level documentation #776

jonpryor opened this issue Jan 11, 2021 · 0 comments
Assignees
Labels
enhancement Proposed change to current functionality javadoc Issues with consuming Java documentation formats

Comments

@jonpryor
Copy link
Member

Package-level documentation is stored in package-info.java:

package-info.java - Can contain a package declaration, package annotations, package comments and Javadoc tags.

java-source-utils.jar should read these files and emit them into /package/javadoc elements:

<api api-source="java-source-utils">
  <package jni-name="java/lang" name="java.lang">
    <javadoc>
      <![CDATA[Provides classes that are fundamental to the design of the Java              
      programming language. …]]>
    </javadoc>
    <class jni-name="Ljava/lang/Object;">
      <javadoc>
        <![CDATA[Class {@code Object} is the root of the class hierarchy…

Once java-source-utils.jar imports the package-level documentation, generator can emit mdoc(5)-style namespace documentation files:

<!-- ns-Java.Lang.xml -->
<Namespace Name="Java.Lang">
  <Docs>
    <summary>Provides classes that are fundamental to the design of the Java programming language.</summary>
    <remarks>Provides classes that are fundamental to the design of the Java programming language…</remarks>
  </Docs>
</Namespace>

This will allow importing of Java package-level documentation for display by e.g. https://docs.microsoft.com/en-us/dotnet/api/java.lang?view=xamarin-android-sdk-9

@jonpryor jonpryor self-assigned this Jan 11, 2021
@jonpryor jonpryor added enhancement Proposed change to current functionality generator Issues binding a Java library (generator, class-parse, etc.) labels Jan 11, 2021
@radekdoulik radekdoulik added this to the Under consideration milestone Jan 15, 2021
@jpobst jpobst added javadoc Issues with consuming Java documentation formats and removed generator Issues binding a Java library (generator, class-parse, etc.) labels Jul 19, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement Proposed change to current functionality javadoc Issues with consuming Java documentation formats
Projects
None yet
Development

No branches or pull requests

3 participants