Doxygen php error

Question

I have a php (doxygen.php) file which I'd like to document. The problem is wen I run doxygen doxygen.php on linux it doesn't generate anything...index.html file is empty. I get

Warning: ignoring unknown tag `php' at line 1, file doxygen.php
Warning: ignoring unknown tag `does' at line 4, file doxygen.php
Warning: ignoring unknown tag `nothing' at line 4, file doxygen.php
....

It seems that it doesn't recognize the comments properly. My doxygen.php file has this:

<?php


/* does nothing
 * @param teste
 * @return null
 */
function foo($foo) {
    echo 'hi'.$foo;
    return null;
}

?>

what version of doxygen are you running?

FatherStorm
– FatherStorm

2010-12-16 13:30:17 +00:00
Commented Dec 16, 2010 at 13:30 — FatherStorm
– FatherStorm, Commented Dec 16, 2010 at 13:30

albert · Accepted Answer · 2019-03-26 10:16:33Z

1

when using doxygen you have to set your comments off with

/** ...*/

or /*!...*/

see the doxygen "documenting the code" page

edited Mar 26, 2019 at 10:16

albert

9,2003 gold badges24 silver badges42 bronze badges

answered Dec 16, 2010 at 13:27

FatherStorm

7,1711 gold badge24 silver badges27 bronze badges

Sign up to request clarification or add additional context in comments.

Comments

Mchl · Accepted Answer · 2010-12-16 13:14:10Z

0

Try

/**
 * does nothing
 *
 * @param teste
 * @return null
 */

answered Dec 16, 2010 at 13:14

Mchl

62.4k9 gold badges121 silver badges121 bronze badges

1 Comment

Mchl Over a year ago

must be something with doxygen config. Apart from using /* instead of /** your syntax looks fine.

Ran Bar-Zik · Accepted Answer · 2011-02-17 16:03:04Z

0

You forgot to include file data. use this code instead:

/**
* @file
* Test file intended for doxygen testing
*/


/**
 * does nothing
 *
 * @param teste
 * @return null
 */

function foo($foo) {
    echo 'hi'.$foo;
    return null;
}

It will work. tested it with my doxygen.

answered Feb 17, 2011 at 16:03

Ran Bar-Zik

1,2379 silver badges14 bronze badges

Collectives™ on Stack Overflow

Doxygen php error

3 Answers 3

Comments

1 Comment

Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

3 Answers 3

Comments

1 Comment

Comments

Your Answer

Sign up or log in

Post as a guest

Related