RE: [Doxygen-users] Grouping file members

[Dan M. <dm...@Cr...>]

Dimitri, thanks for the 1.2.11.1 update -- it fixed the problem described
below very nicely!


Dan Muller [mailto:dm...@Cr...] wrote:
>
> I'm having trouble getting grouping to work the way I'd 
> expect for some
> non-member operators defined in a namespace. Following is a 
> test case with
> the same problematic elements as my code. I've actually run this test
> through doxygen and replicated the problem. I'm using doxygen 
> 1.2.11 on
> Win2k Pro.
> 
> /**
>  * @file test.h
>  * This is the file.
>  */
> 
> /**
>  * Foo is a namespace.
>  */
> namespace Foo {
>   class TR;
>   /**
>    * Docs for Rel
>    */
>   class Rel { /*...*/ };
> 
>   //@{
>   /**
>    * Yadda yadda yadda.
>    * @param r This is a Rel
>    * @param t This is a TR.
>    * @return Returns a result of type Rel.
>    * @relates Rel
>    */
>   Rel operator&&(const Rel& r, const TR& t);
>   Rel operator&&(const TR& t, const Rel& r);
>   //@}
> 
> }
> 
> Because of my build setup, the configuration is built in pieces. I've
> attached all the parts (test.cfg is the file actually given 
> to doxygen on
> the command line). The parts of my config which I think might 
> be relevant
> are:
> 
> EXTRACT_ALL     = NO
> HIDE_UNDOC_CLASSES = YES
> HIDE_UNDOC_MEMBERS = YES
> DISTRIBUTE_GROUP_DOC = YES
> 
> My situation seems to correspond to the last part of the last 
> example in the
> "Grouping" section of the doxygen manual. But the behavior 
> doesn't seem to
> match what's described there. I tried changing the operators 
> to regular
> functions, but that doesn't help.
> 
> I'd really like a single documentation block in the HTML 
> output that applies
> to both variations of the operator&&, since they do the same 
> thing, but
> showing both prototypes so the reader can see the symmetry 
> that's provided.
> I'd settle for each prototype listed separately with the documentation
> replicated. But the second operator prototype seems to be ignored by
> doxygen. If I omit @relates, then i get the latter behavior 
> (two entries
> with replicated docs), but on the namespace page. 
> 
> Any suggestions? Is @relates just incompatible with grouping? 
> Is there any
> way to get the kind of grouping I'd actually like, i.e. 
> multiple function
> prototypes documented together?
> 
> 
>  <<all.doxy>>  <<CsiDb.doxy>>  <<test.cfg>> 
>