update doc comments

This commit is contained in:
Michael Davidsaver
2020-05-28 16:26:34 -07:00
parent 688bc3247c
commit 6188d3fdaf
7 changed files with 44 additions and 40 deletions
+1 -8
View File
@@ -12,14 +12,7 @@
*
* \brief Contains a few templates out of the C++ standard header algorithm
*
* \note The templates are provided here in a much smaller file. Standard algorithm
* contains many templates for sorting and searching through C++ template containers
* which are not used in EPICS. If all you need from there is std::min(),
* std::max() and/or std::swap() your code may compile faster if you include
* epicsAlgorithm.h and use epicsMin(), epicsMax() and epicsSwap() instead.
*
* The C++ standard only requires types to be less-than comparable, so
* the epicsMin and epicsMax templates only use operator <.
* \deprecated Use std::min()/max()/swap() in new code
*/
#ifndef __EPICS_ALGORITHM_H__