[Doxygen-develop] Shorter syntax for grouping class members
Brought to you by:
dimitri
From: Daniel F. <dan...@te...> - 2006-02-08 20:32:23
|
Hi, I would like to propose a shorter, easier and more readable syntax for grouping members in a class. I searched the mail archive but didnt find messages about this. With doxygen, if I want to create a group of class members, nowadays I have to write: /** * @name ... * About the group */ //@{ ... //@} My suggestion is to create a new command (eg @members) that automatically starts a new group which goes until the next @members or until the class is closed. /** * @members About the group */ .... /** * @members About the group */ .... IMHO, my suggestion is simplier and more readable. In large classes, with many groups, the lines with //@} and //@{ comments make them difficult to read. IDEs do not understand these comments and do not provide folding or hiding. The grouping results in an overhead of 4 additional lines. The //@} and //@{ are difficult to see and easy to forget. On well organized projects, class attributes and methods are frequently grouped. I like to group them at least like: attributes, references, constructor/destructor and several groups of methods. As this kind of grouping is very frequent, I believe that it could have a special syntax for it. I am only concerned with classes, but I think a more gerenal model could be implemented to make grouping of other entities easier and more readable. Thanks, DAniel FF |