Provide links to the javadoc of referenced classes in the documentation

[asmith2306]

Hi, it would be really helpful if the reference documentation contained links to key classes, items mentioned, etc. that the docs are describing e.g.

It would be great if things like I've highlighted in the image were linked to the items in question instead of having to go looking for them. It breaks the flow when reading the docs. E.g. to import configuration from other @configuration annotated classes the @configuration text in the paragraphs could link to an example, or at least an API page, etc. The highlighted DataSource text (bottom of uploaded image) could link to something about DataSource and it's use.

Just a suggestion. Overall the docs are great. Thanks.

Edit: another example of what I'm talking about.

The highlighted text should link you to a section / new tab about how exactly you use the debug switch.

[wilkinsona]

Thanks for the suggestions, @asmith2306. I'd like to focus this issue on linking to the API documentation from class names. Can you please open a separate issue for your other suggestion of provide more cross-links to examples, other sections of the documentation, etc?

I've been working on a side project that provides Asciidoctor extension for linking to javadoc. It aims to help to keep the documentation in sync with the code, for example by failing the build if a class or method is renamed or deprecated and the documentation is not updated to match. Hopefully this issue will help me to find the time to finish it.

[asmith2306]

@wilkinsona done! Thanks. #13743