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 312655 - DISTRIBUTE_GROUP_DOC fails under some circumstances
DISTRIBUTE_GROUP_DOC fails under some circumstances
Status: RESOLVED FIXED
Product: doxygen
Classification: Other
Component: general
1.5.3-SVN
Other Windows
: Normal normal
: ---
Assigned To: Dimitri van Heesch
Dimitri van Heesch
Depends on:
Blocks:
 
 
Reported: 2005-08-05 10:14 UTC by Simon Sparkes
Modified: 2008-05-18 13:30 UTC
See Also:
GNOME target: ---
GNOME version: ---


Attachments
Zip file containing test class and output (28.56 KB, application/x-zip-compressed)
2005-08-05 11:08 UTC, Simon Sparkes
Details

Description Simon Sparkes 2005-08-05 10:14:46 UTC
Version details: 1.4.4
Distribution/Version: XP Pro SP2

With DISTRIBUTE_GROUP_DOC set to YES on the following file:

/**
*** @brief	Test class
***
*** This is a test class for doxygen testing
**/
class Test
	{
	/// Constructor
	Test();

	/// @name Works
	/// This works OK
	//@{
	/// @brief A simple method
	void	simple1(int pos);
	void	simple2(int pos);
	//@}
	/// @name Does not work
	/// This does not distribute group documentation correctly.

	//@{
	/// @brief A simple method
	void	simple3(int pos);
	void	simple(int pos);
	//@}
	};

The first group creates distributed documentation as expected, the second 
group does not. However if in the second group you change the name from simple 
to simple4 the distributed documentation is created correctly.
Comment 1 Dimitri van Heesch 2005-08-05 10:52:47 UTC
I have not been able to reproduce the given the example above. I did need to set
EXTRACT_PRIVATE to YES (or add a public: section to the class). 

Please attach a self contained example (source + config in zip) for which you
verified that it _does_ trigger the bug. 
Comment 2 Simon Sparkes 2005-08-05 11:08:10 UTC
Created attachment 50267 [details]
Zip file containing test class and output

ZIP file contains 2 directories:

src - contains the sample class
docs - contains the doxygen files and makefile used to run doxygen (win32.mak)

The actual output is in docs\api (also in the zip file).

- contain
Comment 3 Dimitri van Heesch 2005-08-05 13:48:33 UTC
This seems to be caused by setting SORT_BRIEF_DOCS to YES. I'll look into this...
Comment 4 Dimitri van Heesch 2005-12-04 15:58:04 UTC
Setting the status to NEW, so I do not forget to look into this...
Comment 5 Dimitri van Heesch 2007-10-15 19:40:46 UTC
This bug's version was set to "latest". Since this is a moving target, I changed it to 1.5.3-SVN. If you believe this has already been fixed, then please change the status accordingly.
Comment 6 Francesco Montorsi 2008-03-08 12:21:43 UTC
I've hit this bug, too with doxygen 1.5.5; setting SORT_BRIEF_DOCS=NO indeed solved the problem...
Comment 7 Dimitri van Heesch 2008-03-30 13:41:48 UTC
Confirmed. I will change the distribution algorithm such that the first item with documentation in the membergroup is searched, and that documentation is then distributed to the other members.
Comment 8 Dimitri van Heesch 2008-05-18 13:30:38 UTC
This bug was marked as assigned, which means it should be fixed in doxygen release 1.5.6. Please verify if the bug is indeed fixed. If not then reopen it and provide additional information if possible.