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

@author

Author of current element

by Gregory Beaver
Tag Documentation written by cellog@php.net
Copyright 2002, Gregory Beaver
(phpDocumentor 0.1+)
@author authorname
<authoremail@example.com>

Description

The @author tag is used to document the author of any element that can be documented (global variable, include, constant, function, define, class, variable, method, page). phpDocumentor will take any text between angle brackets

(< and >)
and try to parse it as an email address. If successful, it will be displayed with a mailto link in the page

NEW v1.2 - @author is now inherited by child classes from a parent class, see inline {@inheritdoc}.

Example

  1. /**
  2.  * Page-Level DocBlock example.
  3.  * displays as Gregory Beaver<strong>cellog@php.net</strong>
  4.  * , where underlined text is a "mailto:cellog@php.net" link
  5.  * @author Gregory Beaver <cellog@php.net>
  6.  */
  7. /**
  8.  * function datafunction
  9.  * another contributor authored this function
  10.  * @author Joe Shmoe
  11.  */
  12. function datafunction()
  13. {
  14. ...
  15. }

Prev Up Next
@access phpDocumentor tags @category

Documentation generated on Tue, 06 Dec 2011 07:15:45 -0600 by phpDocumentor 1.4.4