Re: [vsipl++] [PATCH] Fir<> IPP cleanup

[Stefan Seefeld <stefan@xxxxxxxxxxxxxxxx>]

Nathan (Jasper) Myers wrote:
> On Thu, Oct 27, 2005 at 02:05:35PM -0400, Stefan Seefeld wrote:
> > All comments meant to be documentation should be prefixed with a
> > triple slash ('///'). Normal comments will be filtered out in
> > the document extraction.
>
> Does it distinguish between user documentation and internal
> documentation?  In this case, e.g., only somebody looking at code 
> in the same file needs to read those comments.
Yes, '///' is meant for reference manual generation, while '//' is not.
The reason I thought you were talking about 'publics' comment was because
Fir_driver itself will end up in the manual, together with its (public)
members so it would make sense to show the docs, too.

Regards,
		Stefan