Andre Poenitz wrote:
On Thu, Aug 30, 2007 at 04:38:02PM -0500, Bo Peng wrote:
+/// child document can be embedded
+void registerEmbeddedFiles(Buffer const &, EmbeddedFiles &,
+ParConstIterator const &) const;
protected:
InsetInclude(InsetInclude const &);
///
The comment above is incorrect. We reserve /// for doxygen notation. I know
that I am guilty in this regard (not to document functions) but that should
not be an excuse to misuse doxygen. :-)
I do not understand this. We are using doxygen, right? What is wrong
with documenting this function in doxygen format?
Btw: Anybody ever thought of putting documentation into the .cpp files?
Less recompilation on documentation changes, and docs stay closer to
the implementation, so they are more likely to be updated with the
implementation.
In another project we put short doxygen title in the header and the long
version in the cpp file.
Abdel.
