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

Add links to other public javadoc pages #166

Merged
merged 5 commits into from
Jan 4, 2019
Merged

Add links to other public javadoc pages #166

merged 5 commits into from
Jan 4, 2019

Conversation

ST-DDT
Copy link
Collaborator

@ST-DDT ST-DDT commented Dec 28, 2018

Adds links to other public javadoc pages.

This has the following benefits

  • Replaces fqcn with links to the official docs, which are usually more useful then just the name.
  • Allows creating proper hierarchies for custom implementations (?)
  • Derive some javadocs from the external parents (?)

Limitations

TBD/TBC

  • Do we want the external links at all?
  • Currently the javadoc links for spring reference a specific version of spring which is not bound to the dependency version. Is it possible to somehow reference the variables instead?
  • Need to check which version of the spring-framework is actually used in the referenced spring-boot lib.

@ST-DDT ST-DDT added the enhancement A feature request or improvement label Dec 28, 2018
@yidongnan
Copy link
Collaborator

Do we want the external links at all?

I think this is ok.

Currently the javadoc links for spring reference a specific version of spring which is not bound to the dependency version. Is it possible to somehow reference the variables instead?
Need to check which version of the spring-framework is actually used in the referenced spring-boot lib.

We can read the version of the dependency from the dependency manager

yidongnan
yidongnan previously approved these changes Jan 2, 2019
@ST-DDT
Copy link
Collaborator Author

ST-DDT commented Jan 2, 2019

Currently the javadoc links for spring reference a specific version of spring which is not bound to the dependency version. Is it possible to somehow reference the variables instead?
Need to check which version of the spring-framework is actually used in the referenced spring-boot lib.

We can read the version of the dependency from the dependency manager

Do you know how to do this? Does it work like this?

@yidongnan yidongnan merged commit cb1a04f into master Jan 4, 2019
@yidongnan yidongnan deleted the javadoc-links branch January 4, 2019 23:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement A feature request or improvement
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants