Skip to content

Commit

Permalink
Bug 626105 - @var in php is not documented
Browse files Browse the repository at this point in the history
Small clarification in case of datatype for php.
  • Loading branch information
albert-github committed May 11, 2018
1 parent c78c338 commit d832659
Showing 1 changed file with 9 additions and 1 deletion.
10 changes: 9 additions & 1 deletion doc/commands.doc
Original file line number Diff line number Diff line change
Expand Up @@ -1108,6 +1108,14 @@ Structural indicators
This command is equivalent to \ref cmdfn "\\fn",
\ref cmdproperty "\\property", and \ref cmdtypedef "\\typedef".

Note that for PHP one can also specify the type of the variable.
The syntax is similar as for the `phpDocumentor` but the description has to start
at the next line, i.e.
\verbatim
@var datatype $varname
Description
\endverbatim

\sa section \ref cmdfn "\\fn", \ref cmdproperty "\\property", and \ref cmdtypedef "\\typedef".

<hr>
Expand Down Expand Up @@ -1571,7 +1579,7 @@ void setPosition(double x,double y,double z,double t)
Note that for PHP one can also specify the type (or types if you
separate them with a pipe symbol) which are allowed for a parameter
(as this is not part of the definition).
The syntax is the same as for phpDocumentor, i.e.
The syntax is the same as for the `phpDocumentor`, i.e.
\verbatim
@param datatype1|datatype2 $paramname description
\endverbatim
Expand Down

0 comments on commit d832659

Please sign in to comment.