GNOME Bugzilla – Bug 539333
Grouping Of Simple Sections
Last modified: 2018-07-30 10:52:32 UTC
The current behavior of simple section commands such as note, remarks, return, authors, version, since, data etc... are rendered linearly, and each section is placed into the documentation in the exact order it is encountered. However for some simple sections it would be desirable to concatenate all instances of that simple section in a particular documentation block. This feature request is for a configuration option allowing that for some simple section, all instances encountered in a documentation block be displayed in a common location in the resulting doxygen generated output. This will apply on a per-(class, function, variable) basis. This grouping functionality could potentially help standardize the presentation of existing doxygen projects. It also provides an alternative to the linear presentation which is currently used throughout the doxygen documentation. It is an enhancement to the existing simple section functionality and would not modify the behavior of doxygen unless explicitly asked for by a user.
Created attachment 113235 [details] [review] Patch Which Implements Grouping Feature This patch contains all the changes needed to group simple sections. It also contains a description of the configuration option which was added to enable this functionality. This patch also contains a new simple section command (progression or ps) which is designed to take advantage of this feature. Along with the command is included documentation and a new example demonstrating the basic functionality provided by the command. There were some interface changes needed to implement the primary functionality included in this patch, and it may need some review. Hopefully the choices made during the interface change will prove to be suitable.
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!