]> source.dussan.org Git - aspectj.git/commitdiff
Fix most xref/link URLs in main documentation index
authorAlexander Kriegisch <Alexander@Kriegisch.name>
Wed, 3 Jan 2024 03:43:34 +0000 (10:43 +0700)
committerAlexander Kriegisch <Alexander@Kriegisch.name>
Sat, 6 Jan 2024 09:09:11 +0000 (10:09 +0100)
To do:
  - API docs (javadoc)
  - all-in-one guides
  - Eclipse website links
  - add links to markdown files (maybe convert md to adoc)

Signed-off-by: Alexander Kriegisch <Alexander@Kriegisch.name>
docs/faq/faq.adoc
docs/index.adoc

index edc265c117a537e0d2f8f1acdb708cf53285fe86..1b1ecfe4a32aa8420859dd7534030faca5ea3c39 100644 (file)
@@ -3109,6 +3109,7 @@ not hold BCEL structures in memory after our evaluation completes.
 
 *A:* Visit the AspectJ project web site: https://eclipse.org/aspectj.
 
+[[ajcbugs]]
 *Q:* How do I submit a bug report?
 
 *A:* You can submit a bug from
index c1e4f1e9824179e97b602acc540e430c41129cb0..7bc6c3370023c3d7191a9da5806ef574c0f633cf 100644 (file)
@@ -12,13 +12,13 @@ for AspectJ 5.
 |===
 |+++Section+++ |+++Contents+++
 
-|xref:#documentation[Documentation] |xref:../../faq/faq.adoc#faq[FAQ], link:quick5.pdf[Quick
-Reference (AspectJ 5)], link:quick.pdf[Quick Reference (1.2.1)],
-xref:../../adk15notebook/adk15notebook.adoc[AspectJ 5 Developer's Notebook],
-link:progguide/index.html[programming],
-link:devguide/index.html[development] and
-link:pdguide/index.html[problem diagnosis] guides,
-link:runtime-api/index.html[API] and link:examples/[example code].
+|xref:#documentation[Documentation] |xref:faq/faq.adoc#faq[FAQ], xref:dist/doc/quick5.pdf[Quick
+Reference (AspectJ 5)], xref:dist/doc/quick.pdf[Quick Reference (1.2.1)],
+xref:adk15notebook/adk15notebook.adoc[AspectJ 5 Developer's Notebook],
+xref:progguide/index.adoc[programming],
+xref:devguide/index.adoc[development] and
+xref:pdguide/index.adoc[problem diagnosis] guides,
+link:runtime-api/index.html[API] and link:https://github.com/eclipse-aspectj/aspectj/tree/master/docs/dist/doc/examples[example code].
 
 |xref:#distributions[Distributions]
 |https://eclipse.org/aspectj[AspectJ]; development environment support
@@ -38,86 +38,86 @@ mailto:aspectj-dev@eclipse.org[developers].
 [width="100%",cols="50%,50%",options="header",]
 |===
 |Documentation |Description
-|link:quick5.pdf[AspectJ 5 Quick Reference] |This is a four-page quick
+|xref:dist/doc/quick5.pdf[AspectJ 5 Quick Reference] |This is a four-page quick
 reference for the AspectJ 5 language.
 
-|link:quick.pdf[AspectJ Quick Reference] |This is a two-page quick
+|xref:dist/doc/quick.pdf[AspectJ Quick Reference] |This is a two-page quick
 reference for the AspectJ language.
 
-|xref:../../adk15notebook/adk15notebook.adoc[AspectJ 5 Developer's Notebook] +
-(printable link:adk15notebook/printable.html[html]) |This describes the
+|xref:adk15notebook/adk15notebook.adoc[AspectJ 5 Developer's Notebook] +
+(printable xref:adk15notebook/printable.html[html]) |This describes the
 changes to the AspectJ language and tools introduced in the AspectJ 5
 Development Kit. These changes are additive, and are not yet reflected
 in the programming guide or quick reference.
 
-|link:progguide/index.html[Programming Guide] +
-(printable link:progguide/printable.html[html]) |This introduces AOP and the
-AspectJ language. link:progguide/starting.html[Getting Started]
+|xref:progguide/index.adoc[Programming Guide] +
+(printable xref:progguide/printable.html[html]) |This introduces AOP and the
+AspectJ language. xref:progguide/gettingstarted.adoc[Getting Started]
 describes basic semantics, and shows development- and production-time
-applications. link:progguide/language.html[The AspectJ Language]
+applications. xref:progguide/language.adoc[The AspectJ Language]
 describes join points, pointcuts, advice, and introduction, all features
-new to AOP. link:progguide/examples.html[Examples] walks you through the
+new to AOP. xref:progguide/examples.adoc[Examples] walks you through the
 examples included with the documentation, and there are two short
-chapters on useful link:progguide/idioms.html[Idioms] and a few
-link:progguide/pitfalls.html[Pitfalls] The appendices have reference
-information: the link:progguide/quick.html[Quick Reference] summarizes
-AspectJ syntax, the link:progguide/semantics.html[Language Semantics]
+chapters on useful xref:progguide/idioms.adoc[Idioms] and a few
+xref:progguide/pitfalls.html[Pitfalls] The appendices have reference
+information: the xref:progguide/quickreference.adoc[Quick Reference] summarizes
+AspectJ syntax, the xref:progguide/semantics.adoc[Language Semantics]
 best describes AspectJ usage, and
-link:progguide/implementation.html[Implementation Notes] describes how
+xref:progguide/implementation.adoc[Implementation Notes] describes how
 the current version is limited to code the compiler controls.
 
-|link:devguide/index.html[Development Environment Guide] +
-(printable link:devguide/printable.html[html]) |This is a guide to
-link:devguide/ajc-ref.html[ajc], the command-line compiler;
-link:devguide/ajbrowser.html[ajbrowser], the stand-alone GUI for
+|xref:devguide/index.adoc[Development Environment Guide] +
+(printable xref:devguide/printable.html[html]) |This is a guide to
+xref:devguide/ajc.adoc[ajc], the command-line compiler;
+xref:devguide/ajbrowser.adoc[ajbrowser], the stand-alone GUI for
 compiling and viewing crosscutting structure; and the
-link:devguide/antTasks.html[Ant tasks] for building AspectJ programs.
+xref:devguide/antsupport.adoc[Ant tasks] for building AspectJ programs.
 
-|link:pdguide/index.html[Problem Diagnosis Guide] +
-(printable link:pdguide/printable.html[html]) |This has a guide to the
+|xref:pdguide/index.adoc[Problem Diagnosis Guide] +
+(printable xref:pdguide/printable.html[html]) |This has a guide to the
 various features available such as messages and trace to help you both
 solve problems with you own programs and report bugs to the AspectJ
 team.
 
-|link:runtime-api/index.html[AspectJ API] |API documentation for AspectJ
+|xref:runtime-api/index.html[AspectJ API] |API documentation for AspectJ
 runtime classes. JoinPoint shows the state automatically available at
-each join point. See also the link:weaver-api/index.html[Weaver API]
+each join point. See also the xref:weaver-api/index.html[Weaver API]
 
-|xref:../../faq/faq.adoc#faq[FAQ] |Frequently-asked questions about the AspectJ
+|xref:faq/faq.adoc#faq[FAQ] |Frequently-asked questions about the AspectJ
 language, tools, and project.
 
 |README's |Changes and porting guide for AspectJ
-xref:README-1921.adoc[1.9.21],
-xref:README-1920.adoc[1.9.20 and 1.9.20.1], xref:README-1919.adoc[1.9.19],
-xref:README-199.adoc[1.9.9 and 1.9.9.1], xref:README-198.adoc[1.9.8],
-xref:README-197.adoc[1.9.7], xref:README-196.adoc[1.9.6],
-xref:README-195.adoc[1.9.5], xref:README-194.adoc[1.9.4],
-xref:README-193.adoc[1.9.3], xref:README-192.adoc[1.9.2],
-xref:README-191.adoc[1.9.1], xref:README-190.adoc[1.9.0],
-xref:README-1811.adoc[1.8.11], xref:README-1810.adoc[1.8.10],
-xref:README-189.adoc[1.8.9], xref:README-188.adoc[1.8.8],
-xref:README-187.adoc[1.8.7], xref:README-186.adoc[1.8.6],
-xref:README-185.adoc[1.8.5], xref:README-184.adoc[1.8.4],
-xref:README-183.adoc[1.8.3], xref:README-182.adoc[1.8.2],
-xref:README-181.adoc[1.8.1], xref:README-180.adoc[1.8.0],
-xref:README-174.adoc[1.7.4], xref:README-173.adoc[1.7.3],
-xref:README-172.adoc[1.7.2], xref:README-171.adoc[1.7.1],
-xref:README-170.adoc[1.7.0], xref:README-1612.adoc[1.6.12],
-xref:README-1611.adoc[1.6.11], xref:README-1610.adoc[1.6.10],
-xref:README-169.adoc[1.6.9], xref:README-168.adoc[1.6.8],
-xref:README-167.adoc[1.6.7], xref:README-166.adoc[1.6.6],
-xref:README-165.adoc[1.6.5], xref:README-164.adoc[1.6.4],
-xref:README-163.adoc[1.6.3], xref:README-162.adoc[1.6.2],
-xref:README-161.adoc[1.6.1], xref:README-160.adoc[1.6.0],
-xref:README-154.adoc[1.5.4], xref:README-153.adoc[1.5.3],
-xref:README-152.adoc[1.5.2], xref:README-151.adoc[1.5.1],
-xref:README-150.adoc[1.5.0], xref:README-121.adoc[1.2.1],
-xref:README-12.adoc[1.2.0], xref:README-11.adoc[1.1], and
-xref:porting.adoc[1.0].
-
-|link:changes.html[Changes] |Changes between the latest releases.
-
-|link:examples/[Examples] |AspectJ code to demonstrate some language
+xref:dist/doc/README-1921.adoc[1.9.21],
+xref:dist/doc/README-1920.adoc[1.9.20 and 1.9.20.1], xref:dist/doc/README-1919.adoc[1.9.19],
+xref:dist/doc/README-199.adoc[1.9.9 and 1.9.9.1], xref:dist/doc/README-198.adoc[1.9.8],
+xref:dist/doc/README-197.adoc[1.9.7], xref:dist/doc/README-196.adoc[1.9.6],
+xref:dist/doc/README-195.adoc[1.9.5], xref:dist/doc/README-194.adoc[1.9.4],
+xref:dist/doc/README-193.adoc[1.9.3], xref:dist/doc/README-192.adoc[1.9.2],
+xref:dist/doc/README-191.adoc[1.9.1], xref:dist/doc/README-190.adoc[1.9.0],
+xref:dist/doc/README-1811.adoc[1.8.11], xref:dist/doc/README-1810.adoc[1.8.10],
+xref:dist/doc/README-189.adoc[1.8.9], xref:dist/doc/README-188.adoc[1.8.8],
+xref:dist/doc/README-187.adoc[1.8.7], xref:dist/doc/README-186.adoc[1.8.6],
+xref:dist/doc/README-185.adoc[1.8.5], xref:dist/doc/README-184.adoc[1.8.4],
+xref:dist/doc/README-183.adoc[1.8.3], xref:dist/doc/README-182.adoc[1.8.2],
+xref:dist/doc/README-181.adoc[1.8.1], xref:dist/doc/README-180.adoc[1.8.0],
+xref:dist/doc/README-174.adoc[1.7.4], xref:dist/doc/README-173.adoc[1.7.3],
+xref:dist/doc/README-172.adoc[1.7.2], xref:dist/doc/README-171.adoc[1.7.1],
+xref:dist/doc/README-170.adoc[1.7.0], xref:dist/doc/README-1612.adoc[1.6.12],
+xref:dist/doc/README-1611.adoc[1.6.11], xref:dist/doc/README-1610.adoc[1.6.10],
+xref:dist/doc/README-169.adoc[1.6.9], xref:dist/doc/README-168.adoc[1.6.8],
+xref:dist/doc/README-167.adoc[1.6.7], xref:dist/doc/README-166.adoc[1.6.6],
+xref:dist/doc/README-165.adoc[1.6.5], xref:dist/doc/README-164.adoc[1.6.4],
+xref:dist/doc/README-163.adoc[1.6.3], xref:dist/doc/README-162.adoc[1.6.2],
+xref:dist/doc/README-161.adoc[1.6.1], xref:dist/doc/README-160.adoc[1.6.0],
+xref:dist/doc/README-154.adoc[1.5.4], xref:dist/doc/README-153.adoc[1.5.3],
+xref:dist/doc/README-152.adoc[1.5.2], xref:dist/doc/README-151.adoc[1.5.1],
+xref:dist/doc/README-150.adoc[1.5.0], xref:dist/doc/README-121.adoc[1.2.1],
+xref:dist/doc/README-12.adoc[1.2.0], xref:dist/doc/README-11.adoc[1.1], and
+xref:dist/doc/porting.adoc[1.0].
+
+|xref:dist/doc/changes.adoc[Changes] |Changes between historical releases up to 1.6.0.
+
+|link:https://github.com/eclipse-aspectj/aspectj/tree/master/docs/dist/doc/examples[Examples] |AspectJ code to demonstrate some language
 features and implement JavaBean properties, the Observer pattern, a
 tracing library, and a game application where aspects handle display
 updating.
@@ -138,7 +138,7 @@ as the documentation and examples.
 AspectJ is available under the open-source
 https://www.eclipse.org/org/documents/epl-2.0/EPL-2.0.txt[Eclipse Public
 License v 2.0] license from the Git repositories for the AspectJ
-project. See the xref:../../faq/faq.adoc#buildingsource[FAQ entry].
+project. See the xref:faq/faq.adoc#buildingsource[FAQ entry].
 
 |https://eclipse.org/ajdt[AspectJ for Eclipse] |AspectJ Development
 Environment support for Eclipse is available under Eclipse Public
@@ -174,7 +174,7 @@ https://bugs.eclipse.org/bugs/buglist.cgi?product=AspectJ&component=Ant[Ant]
 https://bugs.eclipse.org/bugs/buglist.cgi?product=AspectJ&component=Docs[Docs]
 (for the documentation). Bugs all users should know about are
 https://bugs.eclipse.org/bugs/buglist.cgi?product=AspectJ&keywords=info[flagged
-with the "info" keyword]. See the faq.html#q:ajcbugs[FAQ entry] for
+with the "info" keyword]. See the xref:faq/faq.adoc#ajcbugs[FAQ entry] for
 instructions on submitting compiler bugs.
 
 |===
@@ -183,32 +183,32 @@ instructions on submitting compiler bugs.
 === Suggested learning paths for those new to AspectJ
 
 To learn the AspectJ language, read the
-link:progguide/index.html[Programming Guide], keeping the
-link:progguide/semantics.html[Semantics appendix] nearby as the best
+xref:progguide/index.adoc[Programming Guide], keeping the
+xref:progguide/semantics.adoc[Semantics appendix] nearby as the best
 reference for AspectJ usage. Focus initially on the join point model and
 pointcuts, concepts AOP adds to OOP. To read about how the
-link:examples/[examples] work, see the
-link:progguide/examples.html[Examples] section in the
-link:progguide/index.html[Programming Guide]. View and navigate the
+link:https://github.com/eclipse-aspectj/aspectj/tree/master/docs/dist/doc/examples[examples] work, see the
+xref:progguide/examples.adoc[Examples] section in the
+xref:progguide/index.adoc[Programming Guide]. View and navigate the
 crosscutting structure using https://eclipse.org/ajdt[AJDT]; if you can't
 use Eclipse, try the `ajbrowser` structure viewer, as described in the
-link:devguide/ajbrowser.html[AspectJ Browser] section of the
-link:devguide/index.html[Development Environment Guide].
+xref:devguide/ajbrowser.adoc[AspectJ Browser] section of the
+xref:devguide/index.adoc[Development Environment Guide].
 
 To start using AspectJ with your own code, modify the example aspects to
 apply to your classes. As you learn, use the compiler's `-Xlint` flags
 to catch some common mistakes. (Understand that the
-link:progguide/implementation.html[current implementation] is limited to
+xref:progguide/implementation.adoc[current implementation] is limited to
 code the compiler controls.)
 
 To plan how to adopt AspectJ into a project, read the
-link:progguide/index.html[Programming Guide] on development- and
+xref:progguide/index.adoc[Programming Guide] on development- and
 production-time aspects and the FAQ entries for
-xref:../../faq/faq.adoc#howToStartUsing[How should I start using AspectJ?],
-xref:../../faq/faq.adoc#adoption[Deciding to adopt AspectJ], the Development tools
-sections (xref:../../faq/faq.adoc#integrateWithDevTools[How does AspectJ integrate with existing Java development tools?],
-xref:../../faq/faq.adoc#devtools[Integrating AspectJ into your development environment], xref:../../faq/faq.adoc#ltw[Load-time weaving]), and
-xref:../../faq/faq.adoc#opensource[AspectJ as open-source].
+xref:faq/faq.adoc#howToStartUsing[How should I start using AspectJ?],
+xref:faq/faq.adoc#adoption[Deciding to adopt AspectJ], the Development tools
+sections (xref:faq/faq.adoc#integrateWithDevTools[How does AspectJ integrate with existing Java development tools?],
+xref:faq/faq.adoc#devtools[Integrating AspectJ into your development environment], xref:faq/faq.adoc#ltw[Load-time weaving]), and
+xref:faq/faq.adoc#opensource[AspectJ as open-source].
 
 Enjoy the language!