// *** Select any of the comment styles below for defines *************** // *** Inline comment example: #define NUMSAMPLES 1000 //!< Number of samples in some buffer // *** Comment Immediately before the define: treated as @brief comment: //! Size of some input buffer #define IN_BUF_SIZE 200 // *** Comment block with brief and detailed description // *** (separated by a blank comment line): /*! * @Brief Find the maximum of two numbers. * * Longer definition of the define that can be one or more paragraphs. * Paragraphs should be separated by a blank line. Be sure that there's * no blank line between the comment and the actual define statement * * If you have a macro with arguments, you can refer to the arguments * of the macro using something like: Finds the maximum of @a x and @a y */ #define MAX(x,y) ((x)>(y)?(x):(y))