Previous Up Next
@abstract phpDocumentor tags @author

@access

Access control for an element. @access private prevents documentation of the following element (if enabled).

Gregory Beaver
Tag Documentation written by cellog@php.net
Copyright 2002, Gregory Beaver
(phpDocumentor 0.1+)
@access private protected public

Description

@access controls phpDocumentor's documentation of an element.

If @access is private, the element will not be documented unless specified by command-line switch --parseprivate.

Example

  1. /**
  2.  * function func1, public access is assumed
  3.  */
  4. function func1()
  5. {
  6. }
  7.  
  8. /**
  9.  * function func2, access is private, will not be documented
  10.  * @access private
  11.  */
  12. function func2()
  13. {
  14. }
  15.  
  16. /**
  17.  * This is possible, but redundant.  An element has @access public by default
  18.  * @access public
  19.  */
  20. class class1
  21. {
  22.    /**
  23.     * all text in this DocBlock will be ignored, unless command-line switch or
  24.     * setting in a user INI file enables documenting of private elements
  25.     * @access private
  26.     */
  27.    var $private_var;
  28.    /**
  29.     * Protected is allowed, but does absolutely nothing.  Use it to inform users
  30.     * that an element should only be referenced by this and child classes,
  31.     * and not directly
  32.     * @access protected
  33.     */
  34.    
  35.    /**
  36.     * this function is documented
  37.     */
  38.    function publicmethod()
  39.    {
  40.    }
  41. }

Previous Up Next
@abstract phpDocumentor tags @author

Documentation generated on Mon, 05 Dec 2011 21:07:26 -0600 by phpDocumentor 1.4.4