-
Notifications
You must be signed in to change notification settings - Fork 240
@aside
nene edited this page Mar 17, 2012
·
10 revisions
Syntax:
@aside ( guide | video | example ) <name>
A special type of cross-references can be created with @aside
tag to easily link relevant guide, video or example from class documentation:
/**
* @class MyClass
*
* A class documentation with links to extra materials.
*
* @aside guide using-myclass
* @aside video myclass-tutorial
* @aside example myclassexample
*/
All these resources are referenced by the name defined in their corresponding JSON config file. See the Advanced Usage guide for details.