Re: [Doxygen-users] Getting started with Doxygen
Brought to you by:
dimitri
From: Philipp M. <ph...@ma...> - 2007-05-26 08:32:47
|
On Samstag, 26. Mai 2007 Daniel wrote: > I think that if someone shows me a very simple hello-world type of > document with Doxygen on PHP I can work my way up to my real situation. > Can anyone help? I'm stuck at the very beginning. I can't generate the > most basic documentation with Doxygen. ... > > 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? Yes, it does. I guess that you have <?php in that file? Else doxygen won't find your php code. I'd guess that your doxygen configuration file does not say to read *.php (or .php4, or whatever), or that your input directory(ies) are wrong - possibly you did not say to recurse? Does doxygen on running say that it reads these files? Have a look at doxywizard (http://www.stack.nl/~dimitri/doxygen/doxywizard_usage.html). Regards, Phil -- Versioning your /etc, /home or even your whole installation? Try fsvs (fsvs.tigris.org)! |