After an evaluation, GNOME has moved from Bugzilla to GitLab. Learn more about GitLab.
No new issues can be reported in GNOME Bugzilla anymore.
To report an issue in a GNOME project, go to GNOME GitLab.
Do not go to GNOME Gitlab for: Bluefish, Doxygen, GnuCash, GStreamer, java-gnome, LDTP, NetworkManager, Tomboy.
Bug 557564 - Generated perlmod contains syntax error.
Generated perlmod contains syntax error.
Status: RESOLVED OBSOLETE
Product: doxygen
Classification: Other
Component: general
1.5.7.1
Other Linux
: Normal normal
: ---
Assigned To: Dimitri van Heesch
Dimitri van Heesch
[moved_to_github]
: 596813 (view as bug list)
Depends on:
Blocks:
 
 
Reported: 2008-10-23 08:09 UTC by Mark Toller
Modified: 2018-07-30 10:11 UTC
See Also:
GNOME target: ---
GNOME version: ---



Description Mark Toller 2008-10-23 08:09:49 UTC
I have a header file containing :

///@brief Return satellite Id.
///@details used by TPDBStorageManager template class.
///@see TPDBStorageManager.
///@return unsigned int satellite Id.
unsigned int getId( void );

And the generated perlmod contains :

detailed => {
              doc => [
                { 
                  type => 'text',
                  content => 'used by TPDBStorageManager template class. ,
                  see => [TPDBStorageManager. '
                  }
                ],
                return => [
                  {
                    type => 'text',
                    content => 'unsigned int satellite Id.'
                  }
                ]
              ]                                     
            },                                                      

Adding a blank line between @details and @see, i.e. 

///@brief Return satellite Id.
///@details used by TPDBStorageManager template class.
///
///@see TPDBStorageManager.
///@return unsigned int satellite Id.
unsigned int getId( void );

Fixes the problem, and the generated perlmod is :

detailed => {
              doc => [  
                {
                  type => 'text',
                  content => 'used by TPDBStorageManager template class.'
                },
                {
                  type => 'parbreak'
                },
                see => [
                  {
                    type => 'text',
                    content => 'TPDBStorageManager. '
                  }
                ],
                return => [
                  {
                    type => 'text',
                    content => 'unsigned int satellite Id.'
                  }
                ]
              ]
            },
Comment 1 Mark Toller 2008-10-23 08:49:05 UTC
Incorrect doxygen formatting with the \struct tag also generates bad perl :

/*!
\struct CA system ID list
\brief This struct give the header of CA system ID array and length of it
\remarks  pu16Ca_SystemID - CA system ID header
    u16Ca_SystemIDNum - length of CA system ID array
*/
typedef struct 
{
    unsigned short int*    pu16CaSystemID;
    unsigned short int    u16CaSystemIDNum;
} CA_SYSID_LIST;


Changing the \struct line to 

\struct CA_SYSID_LIST

generates good perl results.
Comment 2 Gisbert 2009-09-30 04:50:51 UTC
*** Bug 596813 has been marked as a duplicate of this bug. ***
Comment 3 André Klapper 2018-07-30 10:11:41 UTC
As discussed in https://github.com/doxygen/doxygen/pull/734 , Doxygen has moved its issue tracking to 

   https://github.com/doxygen/doxygen/issues

All Doxygen tickets in GNOME Bugzilla have been migrated to Github. You can subscribe and participate in the new ticket in Github. You can find the corresponding Github ticket by searching for its Bugzilla ID (number) in Github.

Hence I am closing this GNOME Bugzilla ticket.
Please use the corresponding ticket in Github instead. Thanks a lot!