summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authoralbert-github <albert.tests@gmail.com>2018-05-11 10:38:59 (GMT)
committeralbert-github <albert.tests@gmail.com>2018-05-11 10:38:59 (GMT)
commitd83265914607c6556fefa852a90b6a16821b0634 (patch)
treeef4b45776a44fc96460652a0f45f360b43b479d5
parentc78c338fffbdbb9b2379b1896e647f7cc697da57 (diff)
downloadDoxygen-d83265914607c6556fefa852a90b6a16821b0634.zip
Doxygen-d83265914607c6556fefa852a90b6a16821b0634.tar.gz
Doxygen-d83265914607c6556fefa852a90b6a16821b0634.tar.bz2
Bug 626105 - @var in php is not documented
Small clarification in case of datatype for php.
-rw-r--r--doc/commands.doc10
1 files changed, 9 insertions, 1 deletions
diff --git a/doc/commands.doc b/doc/commands.doc
index 1c7e7cf..ae963dd 100644
--- a/doc/commands.doc
+++ b/doc/commands.doc
@@ -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>
@@ -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