Section B.4. Tag Table


B.4. Tag Table

Table B.1 shows an overview of where the tags as described in this appendix might be used. An X marks that a specific tag might be used to document and element, an M specifies that it is mandatory to use that tag to document the element.

Table B.1. Tag Table

Tag

Global Var

Include

Constant

Function

Define

Class

Variable

Method

Page

Access

X

X

X

X

X

X

X

X

X

Author

X

X

X

X

X

X

X

X

X

Copyright

X

X

X

X

X

X

X

X

X

Deprecated

X

X

X

X

X

X

X

X

X

Example

X

X

X

X

X

X

X

X

X

Ignore

X

X

X

X

X

X

X

X

X

internal

X

X

X

X

X

X

X

X

X

Link

X

X

X

X

X

X

X

X

X

link (inline)

X

X

X

X

X

X

X

X

X

see

X

X

X

X

X

X

X

X

X

since

X

X

X

X

X

X

X

X

X

tutorial

X

X

X

X

X

X

X

X

X

version

X

X

X

X

X

X

X

X

X

name

X

   

X

    

global

M

  

X

   

X

 

param

   

X

   

X

 

return

   

X

   

X

 

staticvar

      

X

  

package

     

X

  

X

subpackage

     

X

  

X

static

     

X

 

X

 

inline {@source}

   

X

   

X

 

inline {@inheritdoc}

     

X

X

X

 

abstract

     

X

X

X

 

filesource

        

X

category

     

X

  

X

final

     

X

 

X

 

licence

X

X

X

X

X

X

X

X

X

todo

X

X

X

X

X

X

X

X

X

tutorial

X

X

X

X

X

X

X

X

X

uses

X

X

X

X

X

X

X

X

X

var

      

X

  




    PHP 5 Power Programming
    PHP 5 Power Programming
    ISBN: 013147149X
    EAN: 2147483647
    Year: 2003
    Pages: 240

    flylib.com © 2008-2017.
    If you may any questions please contact us: flylib@qtcs.net