Plugin documentation generator - add support for inline tag link #4242

Closed
tsteur opened this Issue Oct 26, 2013 · 3 comments

1 participant

@tsteur
Piwik Open Source Analytics member

It would be nice to easily link to other classes & methods within those classes. {@link ... ...} and @see, neither worked. markdown syntax works, but this will become unreadable when reading the docs in code.

@tsteur
Piwik Open Source Analytics member

From what I see Sami does not support inline tags and it would be probably a few or more days work to support it.

FYI: What should work is @link and @see on docblock level: FriendsOfPHP/Sami#8

@tsteur
Piwik Open Source Analytics member

Added {@link destination [description]} support in Class, Property, Method and Constant comments. The following links work so far:

 * {@link Map}  // class within this namespace
 * {@link Piwik\DataTable\Map}  // full classname
 * {@link getKeyName()}   // method within this class
 * {@link $myproperty}    // property within this class
 * {@link Map::getKeyName()} // method from any class
 * {@link Map::$myproperty}  // property from any class
 * {@link http://piwik.org}  // http link
 * {@link https://piwik.org} // https link
 * {@link mailto:test}       // mailto link


 * {@link Map Description Text}  // class within this namespace
 * {@link Piwik\DataTable\Map Description Text}  // full classname
 * {@link getKeyName() Description Text}   // method within this class
 * {@link $myproperty Description Text}    // property within this class
 * {@link Map::getKeyName() Description Text} // method from any class
 * {@link Map::$myproperty Description Text}  // property from any class
 * {@link http://piwik.org Description Text}  // http link
 * {@link https://piwik.org Description Text} // https link
 * {@link mailto:test Description Text}       // mailto link


 * {@link NotExistingClass}
 * {@link Piwik\DataTable\NotExistingClass}
 * {@link notExistingInternalMethod()}
 * {@link $notExistingInternalProperty}
 * {@link Map::notExistingExternalMethod()}
 * {@link NotExistingClass::notExistingExternalMethod()}
 * {@link Map::$notExistingProperty}
 * {@link NotExistingClass::$notExistingMethod}


 * {@link NotExistingClass Description}
 * {@link Piwik\DataTable\NotExistingClass Description}
 * {@link notExistingInternalMethod() Description}
 * {@link $notExistingInternalProperty Description}
 * {@link Map::notExistingExternalMethod() Description}
 * {@link NotExistingClass::notExistingExternalMethod() Description}
 * {@link Map::$notExistingProperty Description}
 * {@link NotExistingClass::$notExistingMethod Description}
@tsteur
Piwik Open Source Analytics member
@tsteur tsteur added this to the 2.0 - Piwik 2.0 milestone Jul 8, 2014
This issue was closed.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment