[Doxygen-users] (no subject)

[Paul B. <pee...@ya...>]

Hi,

Basic question about Doxygen.  Say I have a class
like this

---------------------------
class A
{
public:
  int method1 () const {return simple_thing;}
  void method2 () {do_something_simple ();}
};
---------------------------

I would like to (a) add Doxygen comments
to the methods, but (b) not
clutter up my source code with interspersed
comments.

Here is one solution, all the following is in the
header file -

------------------------------
class A
{
public:
  int method1 ();
  void method2 ();
};

/** 
 * Blah
 * @return blah
*/
int A::method1 () const {return simple_thing;}

/**
 * Blah2
 */
void A::method2 () {do_something_simple ();}
--------------------------------

But I have a question about inlining - will some
compilers fail to inline methods because the
definition is now separate from the declaration?  i.e.
assuming method1 and method2 are inlined in the first
case above, might they be not-inlined in the second
case?

Thanks,
Paul.


__________________________________________________
Do You Yahoo!?
Send FREE video emails in Yahoo! Mail!
http://promo.yahoo.com/videomail/