inline {@internal}}
Mark documentation as private, internal to the software project in text flow
Gregory Beaver
Copyright 2002, Gregory Beaver
(phpDocumentor 1.2+)
{@internal
any text including inline tags
}}
Description
Unlike other inline tags, {@internal}} may contain other inline tags due to its purpose. To terminate an {@internal}} inline tag, you must use two ending brackets "}}"
Use {@internal}} to facilitate the creation of two sets of documentation, one for advanced developers or for internal company use, and the other for the general PHP public. Use this inline tag or its cousin, @internal
Prev |
Up |
Next |
inline {@id} |
phpDocumentor Inline tags |
inline {@inheritdoc} |