Properly use @see
Posted September 25th, 2007 by douggreen
in
6.x-1.x-dev, Code, task, normal, patch (code needs review), stella
I spent some time improving API module's @see parsing. There are a few places where @see is used incorrectly in core.
Example:
* @see some_function(), some-template.tpl.php
Notes:
- @see should always be at the beginning of a line, never inline in other comments.
- Always follow function names with ().
- Keep the references on the same line.
- Separate multiple references with ', '
- No trailing punctuation, this is not a sentence.