bug: doxypress reports undocument param that is documented

Discuss how to use DoxyPress

bug: doxypress reports undocument param that is documented

Postby marlowa » Wed Oct 26 2016 12:56 pm

For quite a while now I have seen this error and am at long last able to reproduce it with a tiny example:

Code: Select all
#ifndef INCLUDED_APM
#define INCLUDED_APM

class apm
{
public:

   /**
     * Return TRUE if something.
     * The whatjamacallit is specified somehow.
     *
    * @param[in] pObject the object
     * @param[in] name the name
    * @param[in] date the start date to query
    * @return TRUE if something, FALSE otherwise
    */
   RWBoolean do_something(const SomeClass* pObject, const RWCString& name, int date);
};

#endif

The output is:
Code: Select all
DoxyPress Version: 1.2.4

**  Read Project Configuration
**  Verify Project Configuration

Initialization
Parse input files

**  Generate Documentation Output
apm.h(17): Warning: The following parameters of apm::do_something(const SomeClass *pObject, const RWCString &name, int date) are not documented:
  parameter 'pObject'

** DoxyPress completed

If you remove the line:
Code: Select all
* The whatjamacallit is specified somehow.

then the error mysteriously goes away.
marlowa
 
Posts: 67
Joined: Sun Oct 25 2015 10:52 am

Re: bug: doxypress reports undocument param that is document

Postby barbara » Fri Nov 11 2016 7:13 pm

Can you confirm the actual documentation output is correct and this is just a warning you are seeing.

I have tried several times but so far I am unable to reproduce the warning. My assumption is that this is related to a configuration option we have set differently. Would it be possible for you to send us your json file so we can test with the exact settings you have turned on / off.

Thanks,

Barbara
barbara
 
Posts: 70
Joined: Sat Apr 04 2015 2:32 am


Return to User Support

cron