Re: [Doxygen-develop] new feature discussion

[Dimitri v. H. <do...@gm...>]

On Tue, 7 Dec 2004 18:29:13 +0100, Antoine Tandin
<at...@ko...> wrote:
> 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.

I agree, but I don't think is it needed to have an option for this:
just always turn this on.
 
> The patch is very simple :
> Just add a condition in the function addDocCrossReference

> 
> 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

This could be useful, but how are you going to express to containment relations.
A "boxes in boxes" approach (which would be natural) doesn't work well with dot.

> 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...

This feature has been discussed and requested before, but I don't think it
will work with the current implementation. If you have an undocumented file
with a member in multiple groups and this member is referred to in some place
to which group would you point? (if the file that actually contains
the member was
documented, the file could be a good candidate, but this is not guaranteed. 

> 
> 4 - SHOW_GROUPLINKS
> Just add in the documentation of members a link to the group(s) they are
> part of. (like for classes)

This could be useful (but less so if the member can be in one group only).

Regards,
  Dimitri