Alias for ASDoc @see



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.):

Actionscript:
  1. // what:
  2. @see    com.yourdomain.YourClass    Your alias
  3.  
  4. // how:
  5. @see    com.rubenswieringa.MyClass  MyClass

..but of course you can use any alias you want to, except for linebreaks and all that nonsense ;)

3 Responses

Note that comments are displayed in reverse chronological order with topmost comments being freshest. Subscribe | Comment

Leave a Reply