diff options
Diffstat (limited to 'doc/autolink.doc')
| -rw-r--r-- | doc/autolink.doc | 17 |
1 files changed, 12 insertions, 5 deletions
diff --git a/doc/autolink.doc b/doc/autolink.doc index 5ddd4df..c6b85f9 100644 --- a/doc/autolink.doc +++ b/doc/autolink.doc @@ -37,8 +37,9 @@ \section linkclass Links to classes. - All words in the documentation that correspond to a documented class - will automatically be replaced by a link to the page containing the + All words in the documentation that correspond to a documented class and + contain at least one upper case character will automatically be replaced by + a link to the page containing the documentation of the class. If you want to prevent that a word that corresponds to a documented class is replaced by a link you should put a \% in front of the word. @@ -59,17 +60,23 @@ <li><tt>\<functionName\>"()"</tt> <li><tt>"::"\<functionName\></tt> <li><tt>(\<className\>"::")<sup>n</sup>\<functionName\>"("\<argument-list\>")"</tt> + <li><tt>(\<className\>"::")<sup>n</sup>\<functionName\>"("\<argument-list\>")"\<modifiers\></tt> <li><tt>(\<className\>"::")<sup>n</sup>\<functionName\>"()"</tt> <li><tt>(\<className\>"::")<sup>n</sup>\<functionName\></tt> </ol> where n\>0. \par Note 1: - The patterns above should not contain spaces, tabs or newlines. - \par Note 2: + Function arguments should be specified with correct types, i.e. + 'fun(const std::string&,bool)' or '()' to match any prototype. + \par Note 2: + Member function modifiers (like 'const' and 'volatile') + are required to identify the target, i.e. 'func(int) const' and 'fun(int)' + target different member functions. + \par Note 3: For JavaDoc compatibility a \# may be used instead of a :: in the patterns above. - \par Note 3: + \par Note 4: In the documentation of a class containing a member foo, a reference to a global variable is made using ::foo, whereas \#foo will link to the member. |