Re: [Doxygen-develop] \interface tag - possible bug?

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

On Fri, 21 Jan 2005 08:50:47 -0400, Christian Baribeau
<chr...@am...> wrote:
> Allo James!
>  
> Just to further amplified your email message.
>  
> I ran the test case test_proc.cc with an older version (Doxygen 1.3.8 on
> Windows) and observed the same the behaviour.
>  
> I looks like the commands used in the test case are missing the a
> description block.
>  
> Is this intended?
>  
> When using /interface and /class commands, you need to following with a
> description block. Among others, you use these commands if you need to
> locate the description the software entity in a different location (i.e. not
> collocated in a separate file or different location within the same file).
>  
> If you try this test case (added description block):/// \interface Int
> /// This is an interface class
> class Int
> {
>     virtual ~Int() {}
>     virtual void Method() = 0;
> };
> /// \class Imp
> /// This is the implementation of the class interface.
> class Imp : public Int
> {
>     void Method() {}
> };
> 
> Then no warnings.
> 
> Now, is it the expected behaviour. Should doxygen not generate a warning if
> the description block is missing?

I think (haven't checked) it is more the difference between a brief
and a detailed description. Probably the \class command is allowed in
a brief description and the \interface command is not. I'm working on
a new scanner for comment blocks which should bring some more
consistency to handling of brief and detailed descriptions w.r.t. the
handling of commands.

Regards,
  Dimitri