Alias for ASDoc @see
by Ruben
You may have noticed that when using the @see tag in your ASDocs, that it uses the actual hyperlink-address as a text.
In short, stating @see com.somedomain.MyClass will look somewhat like ../../com/somedomain/MyClass.html in the generated documentation.
However, some time ago I discovered that you can actually use aliases to make your @see's look prettier, just enter an alias after a whitespace on the same line (tab, space, etc.):
// what: @see com.yourdomain.YourClass Your alias // how: @see com.rubenswieringa.MyClass MyClass
..but of course you can use any alias you want to, except for linebreaks and all that nonsense
Comments
Nice.
I wonder if there are any good, very simple, GUI’s out for using ASDoc :-\ would be nice.
-M
How I can give an hyper link in @see like
@see Java Logging Overview
I get this error
Error: Do not use html in @see. Offending text: Java Logging Overview
Located at logging:Logger.
I’m not sure but I think this should do it:
quote from Ruben:
Note that the last part (“Java Logging Overview”) is the alias, and as such is optional.. Also note that all of the above should be on the same line (my blog layout messes it up).