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

[Nathan (Jasper) Myers]

On Thu, Oct 27, 2005 at 02:05:35PM -0400, Stefan Seefeld wrote:
> Nathan (Jasper) Myers wrote:
> >On Thu, Oct 27, 2005 at 07:44:38AM -0400, Jules Bergmann wrote:
> 
> >>>+  static const bool  reverse_kernel = true;
> >>>+  static const bool  use_native = true;
> >>>+  static const bool  mismatch_ok = true;
> >>
> >>Can you document what 'mismatch_ok' means?
> >
> >OK, added and checked in. 
> 
> 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.

Nathan Myers
ncm