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.

Sign up for GitHub

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

Jump to bottom

Link to current AspectJ Javadoc #34293

Closed
sbrannen opened this issue Jan 21, 2025 · 1 comment
Closed

Link to current AspectJ Javadoc #34293

sbrannen opened this issue Jan 21, 2025 · 1 comment
Assignees
@sbrannen
Labels
in: core Issues in core modules (aop, beans, core, context, expression) type: documentation A documentation task
Milestone
6.2.3

Comments

@sbrannen
Copy link
Member

sbrannen commented Jan 21, 2025 •
edited
Loading

Overview

The Javadoc site we've been using for AspectJ was outdated (based on AspectJ 1.6.6 from October 2009) and was built using a JDK whose javadoc tool generated a package-list file instead of the element-list file needed by Spring Framework's build.

As a consequence, links to AspectJ's Javadoc are currently broken.

For example, the AjType return type for the getAjType() method in the Javadoc for Spring's AspectMetadata is not a link (for Spring Framework 6.2.2).

Thanks to @aclement, the AspectJ runtime Javadoc has been unified into a single Javadoc site (i.e., no longer split between the core runtime JAR and the Java 5 runtime JAR), and the AspectJ 1.9.22.1 Javadoc site is now published at https://eclipse.dev/aspectj/doc/released/1.9.22.1/aspectjrt/, which has a proper element-list file.

@aclement is also considering publishing that under https://eclipse.dev/aspectj/doc/released/latest/aspectjrt/.

In light of the above, we should start using the https://eclipse.dev/aspectj/doc/released/1.9.22.1/aspectjrt/ Javadoc site to restore links to AspectJ types within Spring Framework's Javadoc.

Related Issues
@sbrannen sbrannen added in: core Issues in core modules (aop, beans, core, context, expression) type: documentation A documentation task labels Jan 21, 2025
@sbrannen sbrannen added this to the 6.2.3 milestone Jan 21, 2025
@sbrannen sbrannen self-assigned this Jan 21, 2025
@sbrannen
Copy link
Member Author

For example, the AjType return type for the getAjType() method in the Javadoc for Spring's AspectMetadata is not a link (for Spring Framework 6.2.2).

The AjType return type is now a proper link in the Javadoc for 6.2.3 snapshots: https://docs.spring.io/spring-framework/docs/6.2.3-SNAPSHOT/javadoc-api/org/springframework/aop/aspectj/annotation/AspectMetadata.html

@sbrannen sbrannen mentioned this issue Jan 21, 2025
Closed
sbrannen added a commit that referenced this issue Jan 24, 2025
@sbrannen
Link to AspectJ "runtime-api" Javadoc site
Loading
Loading status checks…
683733a 
The AspectJ team has confirmed that the following Javadoc site hosts
the latest version (currently 1.9.22.1) of the runtime API for AspectJ,
generated with a modern version of the javadoc tool which generates the
element-list file required by the Spring Framework build.

https://eclipse.dev/aspectj/doc/latest/runtime-api/

See eclipse-aspectj/aspectj#321
See gh-34293
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@sbrannen sbrannen

Labels
in: core Issues in core modules (aop, beans, core, context, expression) type: documentation A documentation task
Projects
None yet
Milestone
6.2.3
Development

No branches or pull requests
1 participant
@sbrannen