LancePutnam / Gamma

Generic (Sound) Synthesis Library
Other
462 stars 55 forks source link

Updated some documentation and removed replacement macros obscuring template syntax. #7

Closed gitelope closed 12 years ago

LancePutnam commented 12 years ago

I typically doxy comment like follows:

/// Brief message

/// Detailed message. ///

You need at least two ///s for the detailed message, even if it is only a one liner. Also, the space is required between the brief and detailed messages. I like this syntax since it looks like normal C/C++ commenting and doesn't have a lot of doxy jargon, e.g., \brief, etc.