[Doxygen-develop] new feature discussion
Brought to you by:
dimitri
From: Antoine T. <at...@ko...> - 2004-12-07 17:29:18
|
Hello, I would like to discuss about some new options(features) for doxygen. All of them are triggered by the configuration file. So I introduce them by there configuration name. 1 - NO_TYPEDEF_REFERENCED_BY_RELATION Just don't produce the "Referenced by" paragraph for typedef. Most of the time, this paragraph is long and useless. There is no "reference by" for classes... so why for typedef. The patch is very simple : Just add a condition in the function addDocCrossReference static void addDocCrossReference(MemberDef *src,MemberDef *dst) { //printf("addDocCrossReference src=%s,dst=%s\n",src->name().data(),dst->name().data()); if ( dst->isTypedef() && Config_getBool("NO_TYPEDEF_REFERENCED_BY_RELATION") ) //+++ added line return; //+++ added line if (Config_getBool("REFERENCED_BY_RELATION") && (src->isFunction() || src->isSlot()) ) { dst->addSourceReferencedBy(src); } if ((Config_getBool("REFERENCES_RELATION") || Config_getBool("CALL_GRAPH")) && (src->isFunction() || src->isSlot()) ) { src->addSourceReferences(dst); } } 2 - GROUP_COLLABORATION_GRAPH Create a dot graph on the top of each group page. The graph shows relations between groups : - is the group is part of an other group - is the group contains other groups - all members (class, namespace ...) share with other groups 3 - ALLOW_MEMBER_MULTIGROUP This change the behavior of group pages. With this option set, group page don't contain member documentation but only a link to the member documentation. With this option set, a function can be part of more than one groups. With this option set, function documentation are no more moved to the group page, so for a class member, the documentation stays in the class file... 4 - SHOW_GROUPLINKS Just add in the documentation of members a link to the group(s) they are part of. (like for classes) Please tell me what you think about those features. Keep in mind that they don't change anything if the options are not set. All of those 4 features are independent, but 2 and 4 are more relevant with the 3 set. Thanks |