I thought the "doc follows item" format was   //<   not   ///<

Does the three-slash variety work for you elsewhere?


-----Original Message-----
From: Ron Wilson [mailto:ronw.m...@gmail.com] 
Sent: Thursday, July 12, 2012 11:45 AM
To: doxygen-users
Subject: [Doxygen-users] bug: missing descriptions in generated DoxyDocs.pm

Using ver 1.8.1.1 under Windows 7 Pro

With the following function declaration, the parameter brief and
detailed were not in DoxyDocs.pm

/**
 * Basic test harness function. Set inputs and read outputs of
 * the function under test.
 *
 * @return TRUE if successful.
 */
int Test(
        UINT8 InVal,    ///< [in] Input value for function under test. @pre 
0..150
        char  OutFormat ///< [in] OutFormat Format for parsing OutPort string.
        )

And the result in DoxyDocs.pm:
{
            kind => 'function',
            name => 'Test',
            virtualness => 'non_virtual',
            protection => 'public',
            static => 'no',
            brief => {
              doc => [
                {
                  type => 'text',
                  content => 'Basic test harness function.'
                }
              ]
            },
            detailed => {
              doc => [
                {
                  type => 'text',
                  content => 'Set inputs and read outputs of the
function under test.'
                },
                {
                  type => 'parbreak'
                },
                {
                  return => [
                    {
                      type => 'text',
                      content => 'TRUE if successful.'
                    }
                  ]
                }
              ]
            },
            type => 'int',
            const => 'no',
            volatile => 'no',
            parameters => [
              {
                declaration_name => 'InVal',
                type => 'UINT8'
              },
              {
                declaration_name => 'OutFormat',
                type => 'char'
              }
            ]
          }

Also, why "declaration_name" instead of "name"? The function itself has "name".

------------------------------------------------------------------------------
Live Security Virtual Conference
Exclusive live event will cover all the ways today's security and 
threat landscape has changed and how IT managers can respond. Discussions 
will include endpoint security, mobile security and the latest in malware 
threats. http://www.accelacomm.com/jaw/sfrnl04242012/114/50122263/
_______________________________________________
Doxygen-users mailing list
Doxygen-users@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/doxygen-users

This email was sent to you by Thomson Reuters, the global news and information 
company. Any views expressed in this message are those of the individual 
sender, except where the sender specifically states them to be the views of 
Thomson Reuters.

------------------------------------------------------------------------------
Live Security Virtual Conference
Exclusive live event will cover all the ways today's security and 
threat landscape has changed and how IT managers can respond. Discussions 
will include endpoint security, mobile security and the latest in malware 
threats. http://www.accelacomm.com/jaw/sfrnl04242012/114/50122263/
_______________________________________________
Doxygen-users mailing list
Doxygen-users@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/doxygen-users

Reply via email to