On Thu, Aug 30, 2007 at 05:05:42PM -0500, Bo Peng wrote:
> > > IMHO, document would better stay in .h file.
> >
> > Reasoning?
>
> The most important reason is that comments in .h files are presented
> in a more condensed form.
Given that in theory we'd like comments explaining what's going on,
t
> > IMHO, document would better stay in .h file.
>
> Reasoning?
The most important reason is that comments in .h files are presented
in a more condensed form. I can understand what a class is doing by
reading .h file alone.
Cheers,
Bo
On Thu, Aug 30, 2007 at 04:51:41PM -0500, Bo Peng wrote:
> > 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
> 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.
IMHO, document would better stay in .h file.
Bo
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. W
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 ab
> > +/// 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
On Thursday 30 August 2007 21:46:44 [EMAIL PROTECTED] wrote:
> + /// child document can be embedded
> + void registerEmbeddedFiles(Buffer const &, EmbeddedFiles &,
> + ParConstIterator const &) const;
> protected:
> InsetInclude(InsetInclude const &);
>
