Minor documentation fixes - change \note entries to \warning where appropriate and remove/update old documentation.

This commit is contained in:
Dean Camera 2012-02-24 20:25:36 +00:00
parent 5561524a8f
commit e406140f11
32 changed files with 134 additions and 158 deletions

View file

@ -153,8 +153,8 @@
/** Convenience macro to determine the larger of two values.
*
* \note This macro should only be used with operands that do not have side effects from being evaluated
* multiple times.
* \attention This macro should only be used with operands that do not have side effects from being evaluated
* multiple times.
*
* \param[in] x First value to compare
* \param[in] y First value to compare
@ -167,8 +167,8 @@
/** Convenience macro to determine the smaller of two values.
*
* \note This macro should only be used with operands that do not have side effects from being evaluated
* multiple times.
* \attention This macro should only be used with operands that do not have side effects from being evaluated
* multiple times.
*
* \param[in] x First value to compare
* \param[in] y First value to compare