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

Jules Bergmann jules at codesourcery.com
Thu Oct 27 18:48:26 UTC 2005



Nathan (Jasper) Myers 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, I think that's what its doing.  Comments with a double slash '//' 
are ignored by synopsis/doxygen, making them only visible when looking 
at the code.  Comments with the triple slash '///' get processed by 
synsopsis.

				-- Jules



More information about the vsipl++ mailing list