Packages » Package freddy » File tags.txt

Package freddy, documentation file tags.txt

You can use common HTML tags to additionally format the documentation in your documentational comments and files. In addition to them, you can also use special tags designed primarily to link to other classes, methods, packages or documentation files.

Freddy also specially treats empty lines: if you separate two paragraphs of text with an empty line, the resulting documentation will have a break between these two paragraphs. You do not need to enclose your descriptions in the
b, i, tt, u, ul, ol, li, a

Besides, you can use these special tags:

method
Use this tag to link to other method. The target is declared inside the tag in fully-qualified form:

<method>Document::getBody</method>

This will construct a link to the getBody() method of the Document interface. Note that you do not add any attributes to the method tag
class
This tag allows you to link to a certain class. It uses the same syntax like the method tag:

<class>IterableArray</class>

This will create a link to the documentation of the IterableArray class.
package
Using the package tag you can create link to the package. Follows the same syntax as the two above:

<package>freeform

Be sure to preserve correct case with these tags as package and class names, as well as method names, are case-sensitive for PHP and Freddy.
doc
This tag will link to a package-wide documentation file. Unlike the above tags, it uses attributes to pass the information of the link: file is the file name under the .freddy folder. The optional package attribute denotes the package where the file is located; so, you can create cross-package links:

<doc package="packageName" file="fileName">Description of link

image
You can also distribute images to supplement your package documentation. You include them with the <image> tag:

<image file="fileName" />,

that will try to insert the image specified by fileName in the generated documentation. You can also specify attributes for image formatting like with the img tag.


Please also note that your embedded markup must be well-formed: you must follow the XML rules for nesting elements and empty elements; if you make a mistake; Freddy will not be able to display the description of bad-formed comment.

Related documents