Prev Next

@internal

Mark documentation as private, internal to the software project

by Gregory Beaver
Tag Documentation written by cellog@php.net
Copyright 2002, Gregory Beaver
(phpDocumentor 1.2+)
@internal any information that should not be displayed in public documentation [unspecified format]

Description

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 tag or its cousin, inline {@internal}}

@internal responds to the command-line -pp, --parseprivate, as both @internal and --parseprivate share the same purpose. In both cases, the intent is to allow the creation of two sets of documentation, one for public use, and the other for a subset of developers, either the project developers or those who wish to extend the project. In essence, it allows the creation of both user-level and programmer-level documentation from the same source, and is one of phpDocumentor's most useful features.

Example

Here is an example of how to use @internal and {@internal}}:

  1. /**
  2.  * This class does things
  3.  *
  4.  * {@internal To access the company guidelines on modifying this class,
  5.  * see {@link http://www.example.com Company Guidelines}, or contact
  6.  * your supervisor}}}
  7.  * Using this class can be very helpful for several reasons. etc. etc.
  8.  * @internal the class uses the private methods {@link _foo()} and
  9.  *  {@link _bar()} to do some wacky stuff
  10.  */
  11. class Doesthings

Prev Up Next
@ignore phpDocumentor tags @license

Documentation generated on Mon, 05 Dec 2011 21:24:13 -0600 by phpDocumentor 1.4.4