Hello all,
I need basic help with Doxygen. My long term goal is to contribute
OpenDocument output to Doxygen but first I need to start using the
program myself :-)
1. I have installed Doxygen. I have version 1.4.6.
2. I have made a config file.
3. I'm in a directory ($ROOT) with several sub-directories full of PHP
files.
4. I chose a function at random and added a Doxygen description for it.
5. I went to $ROOT and ran "doxygen my-config-file".
I saw Doxygen run, and it created the appropriate sub-directories in the
output directory I specified in the config files. But there is no
documentation at all in these directories:
$ cd $OUTOUT_DIRECTORY/html
$ ls
doxygen.css index.html tab_l.gif tabs.css
doxygen.png tab_b.gif tab_r.gif
$
I was expecting to find an HTML file for the one function I documented.
Something like MyFunction.html, but as you can see it wasn't documented.
I opened the index.php file and all it has is the HTML header and the
project title from the config file, but nothing else.
Does anyone know what I'm doing wrong?
I notice this in the Doxygen output:
Reading <$ROOT>/include/php/db_access.php...
Parsing file <$ROOT>/include/php/db_access.php...
Where <$ROOT> is the $ROOT directory I stated above. This is the file
where I documented one function. This proves that Doxygen found the file
and read it, so how come it didn't grab the documentation in it?
Is it possible that I wrote the documentation wrong? This is what I have:
/**
* Returns the data necessary to authenticate an initial user login.
*
* \param login is either the full name or email of the user.
*
* \return An associative array:
* user_id: The user ID.
* password: The user password (the hash, actually).
*/
function db_read_login_data($login) {
...
}
Does that look alright?
Btw, yes, this is a procedural program. Doxygen doesn't require OOP,
does it?
Any help would be very much appreciated.
Cheers,
Daniel.
|
