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

Java API Documents Linking #1367

Merged
merged 3 commits into from
Mar 30, 2020
Merged

Java API Documents Linking #1367

merged 3 commits into from
Mar 30, 2020

Conversation

seldridge
Copy link
Member

@seldridge seldridge commented Mar 3, 2020

Three things:

  1. This appends to the build.sbt apiMappings so that linking against Java API docs (for the appropriate version of Java) works. I reuse the same build.sbt from Scala upstream.
  2. This shows an example of this working to link to a Java exception
  3. This shows an example of this working to link to Scala main API docs (which already worked before this PR)

Example:

chisel-scaladoc

This then links to:

chisel-javadoc

Related issue: None

Type of change: documentation

Impact: no functional change

Development Phase: implementation

Release Notes

  • Scaladoc now can link against Javadoc

@seldridge seldridge requested a review from a team as a code owner March 3, 2020 17:38
@seldridge
Copy link
Member Author

Err... Slightly better way to do this with a plugin... Will rebase.

@seldridge seldridge changed the title Javadoc linking Java and Scala Scaladoc Linking Mar 3, 2020
@seldridge seldridge changed the title Java and Scala Scaladoc Linking Java API Documents Linking Mar 23, 2020
@seldridge seldridge requested a review from chick March 23, 2020 21:27
@seldridge seldridge added this to the 3.2.X milestone Mar 23, 2020
@seldridge seldridge added the Please Merge Accepted PRs that are ready to be merged. Useful when waiting on CI. label Mar 23, 2020
This adds the sbt-api-mappings plugin which enables
auto-linking (properly setting the apiMappings for the sbt project) so
that Scaldoc/unidoc generation will now automatically link against
Java and Scala API docs (and use the right version).

Signed-off-by: Schuyler Eldridge <schuyler.eldridge@ibm.com>
Signed-off-by: Schuyler Eldridge <schuyler.eldridge@ibm.com>
Signed-off-by: Schuyler Eldridge <schuyler.eldridge@ibm.com>
Copy link
Contributor

@chick chick left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These look good to me

@mergify mergify bot merged commit a18515b into master Mar 30, 2020
mergify bot pushed a commit that referenced this pull request Mar 30, 2020
* Show linking against Javadoc

Signed-off-by: Schuyler Eldridge <schuyler.eldridge@ibm.com>

* Add sbt-api-mappings plugin

This adds the sbt-api-mappings plugin which enables
auto-linking (properly setting the apiMappings for the sbt project) so
that Scaldoc/unidoc generation will now automatically link against
Java and Scala API docs (and use the right version).

Signed-off-by: Schuyler Eldridge <schuyler.eldridge@ibm.com>

* Show linking against Scala APIs

Signed-off-by: Schuyler Eldridge <schuyler.eldridge@ibm.com>
(cherry picked from commit a18515b)

# Conflicts:
#	core/src/main/scala/chisel3/package.scala
@mergify mergify bot added the Backported This PR has been backported label Mar 30, 2020
seldridge added a commit that referenced this pull request Mar 30, 2020
Signed-off-by: Schuyler Eldridge <schuyler.eldridge@ibm.com>
@seldridge seldridge deleted the javadoc-linking branch March 30, 2020 22:36
ucbjrl pushed a commit that referenced this pull request May 13, 2020
Signed-off-by: Schuyler Eldridge <schuyler.eldridge@ibm.com>

Co-authored-by: Schuyler Eldridge <schuyler.eldridge@ibm.com>
jackkoenig pushed a commit that referenced this pull request Feb 28, 2023
Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Backported This PR has been backported Please Merge Accepted PRs that are ready to be merged. Useful when waiting on CI.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants