epics/epics-base
0
0
Fork 0
Code Issues Pull Requests Projects Wiki Activity

Addying Doxugen annotations for cvtFast.h and freeList.h

Browse Source
This commit is contained in:
Kathryn Baker
2021-03-08 14:24:43 +00:00
committed by Michael Davidsaver
parent 417821ddc0
commit dd09afc4e8
2 changed files with 23 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
modules/libcom/src/cvtFast/cvtFast.h
View File

@@ -7,12 +7,17 @@
* EPICS BASE is distributed subject to a Software License Agreement found
* in file LICENSE that is included with this distribution.
\*************************************************************************/
/*
* Fast numeric to string conversions
/**
* \file cvtFast.h
* \author Bob Dalesio, Mark Anderson, Marty Kraimer
*
* Original Authors:
* Bob Dalesio, Mark Anderson and Marty Kraimer
* Date: 12 January 1993
* \brief Fast numeric to string conversions
*
* \details
* Provides routines for converting various numeric types into an ascii string.
* They off a combination of speed and convenience not available with sprintf().
*
* All functions return the number of characters in the output
*/
#ifndef INCcvtFasth
@@ -27,9 +32,6 @@
extern "C" {
#endif
/*
* All functions return the number of characters in the output
*/
LIBCOM_API int
cvtFloatToString(float val, char *pdest, epicsUInt16 prec);
LIBCOM_API int

15
modules/libcom/src/freeList/freeList.h
View File

@@ -7,7 +7,17 @@
* EPICS Base is distributed subject to a Software License Agreement found
* in file LICENSE that is included with this distribution.
\*************************************************************************/
/* Author: Marty Kraimer Date: 04-19-94 */
/**
* \file freeList.h
* \author Marty Kraimer
*
* \brief Allocate and free fixed size memory elements.
*
* \details
* Describes routines to allocate and free fixed size memory elements.
* Free elements are maintained on a free list rather than being returned to the heap via calls to free.
* When it is necessary to call malloc(), memory is allocated in multiples of the element size.
*/
#ifndef INCfreeListh
#define INCfreeListh
@@ -19,7 +29,7 @@
extern "C" {
#endif
LIBCOM_API void epicsStdCall freeListInitPvt(void **ppvt,int size,int nmalloc);
LIBCOM_API void epicsStdCall freeListInitPvt(void **ppvt, int size, int malloc);
LIBCOM_API void * epicsStdCall freeListCalloc(void *pvt);
LIBCOM_API void * epicsStdCall freeListMalloc(void *pvt);
LIBCOM_API void epicsStdCall freeListFree(void *pvt,void*pmem);
@@ -31,3 +41,4 @@ LIBCOM_API size_t epicsStdCall freeListItemsAvail(void *pvt);
#endif
#endif /*INCfreeListh*/