I added that TimeDialog in Silence.h and was wondering how I do the doxygen
stuff for it. There is no cpp file to go with it, so would I put the \file
stuff at the top of the Silence.h header? Or should I just move the
TimeDialog class to the Effect.h header and document it at the top of
From: James Crook <crookj@in...> - 2006-06-30 11:50:43
> I added that TimeDialog in Silence.h and was wondering how I do the doxygen
> stuff for it. There is no cpp file to go with it, so would I put the \file
> stuff at the top of the Silence.h header? Or should I just move the
> TimeDialog class to the Effect.h header and document it at the top of
I've been wondering that myself.
The overwhelming majority of classes have implementations in an
associated .cpp file. I put the doxygen \class definitions at the top
of those .cpp files in those cases. That seems the 'right' place to me.
For classes which are entirely implemented in their header file, I add
the \brief documentation immediately before the class definition. I
suggest you do that too. I did that for TimeDialog and EffectDialog,
but may have slipped up on checking them in.
No need to move the functions. Only if the class starts to get some
long and complex functions need the functions move to a .cpp file. I
suppose we would move the doxygen documentation with them too.
If doxygen starts to be a burden on people, then it is not helping us.
So, I think we need to have a relaxed attitude to what gets done on the
doxygen side. People who care about it and use it can be responsible
for tweaking it to get the results they want. For example, only a very
few functions need doxygen comments. We're still finding out how to use
Just to confirm that in your message you mean \brief documentation for a
class, not '\file'. \file gets used very occasionally, to document a
file, and often says no more than something like:
\brief Implements Plug, Tap, Kitchen, Sink