Todo - illegal command as part of a \ref

[Anonymous]

I have a PHP class, called MODEL. This class itself is documented, including a todo section. Each member function is also documented. Three of my member functions also include a todo section. Here is a sample:

    /**
     *  Checks to see if a new version is available, and if so, downloads and installs it.
     *
     *  @todo   It is probably not a good idea for us to just update without giving the user an option. Perhaps they
     *          should have a configurable setting, like you do with Windows Updates. If they choose to be notified
     *          before installing updates, we will need some sort of mechanism to show them that an updates is
     *          available with an option to allow the update or ignore it. We should also provide a mechanism to
     *          manually check for updates. Perhaps some kind of web page that resides on the stand-alone server.
     *
     *  @retval string  The resulting output from the update check.
     *
     *  @see    getWebBuild
     */
    public function updateWebUI()
    {
        $return = `php ./update.php`;
        return $return;
    }

When I run

doxygen

, I get this warning: "todo:23: warning: Illegal command updateWebUI as part of a \ref".

The resulting HTML page works fine, except that on the Todo page, the name of the function isn't shown. Instead, it just says "Member MODEL ()". I assume it should say something like "Member MODEL::updateWebUI ()".

This isn't a big deal, since it's just in my Todo list, but am I doing something wrong or is this a bug?

[Manu]

I just found out the same in my newly documentation.
Since I'm using doxygen-1.6.3 on my webserver and 1.7.6.1 on my local machine I can tell this only appears in 1.7.6.1 - it's working correctly, without warning in 1.6.3.
If you did something wrong and found out what, please tell me.

The output in HTML looks like this:
1.6.3: Element class::method ( $args )
1.7.6.1: Element class ( $args )
in both cases class, method and $args are placeholders

[Alexis Wilke]

I have the same error popping up, however, in my case it's not working right. The list of functions are documented, but they do not get a reference from the class summary. Note that I do not have any @todo entries so that has nothing to do with it in my case. However, there is an automatic @ref generated when the system creates the list of public member functions and that's where it fails for me. The functions list in the list of warnings do not appear in that list of functions.