Skip to content

Scala3doc: Add support for annotations in type parameters, add tests for external location providing, minor fixes #10833

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

Merged
merged 4 commits into from
Dec 18, 2020

Conversation

pikinier20
Copy link
Contributor

closes #250
closes #111

Copy link
Contributor

@romanowski romanowski left a comment

Choose a reason for hiding this comment

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

Could we also create a basic integration test for external links? One using Jsoup and parsing generated htmls

def javadocExternalLocationProviderTest(): Unit = {
val provider = createExternalLocationProvider("https://docs.oracle.com/javase/8/docs/api/", ".html", DocumentationKind.Javadoc)
val testcases = List(
(DRI("java.util.Map$$Entry"), "https://docs.oracle.com/javase/8/docs/api/java/util/Map.Entry.html"),
Copy link
Contributor

Choose a reason for hiding this comment

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

shouldn't we add a tests for method base DRI?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I'm gonna make task for that because linking to methods (anchors) are still TODO

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@pikinier20
Copy link
Contributor Author

Added integration tests. @romanowski

Copy link
Contributor

@romanowski romanowski left a comment

Choose a reason for hiding this comment

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

I really like how this PR looks now.

@romanowski romanowski merged commit 33b710a into master Dec 18, 2020
@romanowski romanowski deleted the scala3doc-fixes branch December 18, 2020 14:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

specialization annotation is not included in documentation Generated links are not always unique
2 participants