phpDocumentor
[ class tree: phpDocumentor ] [ index: phpDocumentor ] [ all elements ]
Prev Next

inline {@internal}}

Mark documentation as private, internal to the software project in text flow

by Gregory Beaver
Tag Documentation written by cellog@php.net
Copyright 2002, Gregory Beaver
(phpDocumentor 1.2+)
{@internal any text including inline tags }}

Description

Caution
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}

Documentation generated on Sun, 02 Sep 2012 00:00:39 +0000 by phpDocumentor 1.4.3. PEAR Logo Copyright © PHP Group 2004.