Bug 518703 - AspectJ Notebook should cross-link important keywords
Summary: AspectJ Notebook should cross-link important keywords
Status: NEW
Alias: None
Product: AspectJ
Classification: Tools
Component: Docs (show other bugs)
Version: unspecified   Edit
Hardware: All All
: P3 normal (vote)
Target Milestone: ---   Edit
Assignee: aspectj inbox CLA
QA Contact:
URL:
Whiteboard:
Keywords:
Depends on:
Blocks:
 
Reported: 2017-06-23 08:46 EDT by Roland Illig CLA
Modified: 2017-06-23 08:46 EDT (History)
0 users

See Also:


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description Roland Illig CLA 2017-06-23 08:46:18 EDT
https://eclipse.org/aspectj/doc/released/adk15notebook/jpsigs.html

This chapter mentions several kinds of join points. They are written in blue monospace font. These words should be hyperlinks to their definition, so that the reader doesn't have to guess where the documentation is.

Currently it is difficult to find the allowed pattern for the "kinded pointcut designator" named "execution". This is because:

* neither the word "kinded" nor the word "execution" is a link,

* the whole Notebook does not have an index where all these keywords would be listed,

* the word "kind" does not appear in the table of contents,

* the word "execution" only appears once in the table of contents, but that only refers to the "method execution join point signatures", which have a different syntax from the "kinded pointcut designators".