andreika-git
/
ChibiOS
mirror of https://github.com/andreika-git/ChibiOS.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Fixed some minor documentation issues. 

git-svn-id: svn://svn.code.sf.net/p/chibios/svn/trunk@11083 35acf78f-673a-0410-8e92-d51de3d6d3f4
This commit is contained in:
Giovanni Di Sirio 2017-11-27 16:15:17 +00:00
parent aebe7d83a5
commit 93d79d0b13
1 changed files with 10 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
os/common/oslib/src/chmempools.c
View File

@ -87,7 +87,7 @@ void chPoolObjectInitAligned(memory_pool_t *mp, size_t size,
/** /**
* @brief Loads a memory pool with an array of static objects. * @brief Loads a memory pool with an array of static objects.
* @pre The memory pool must be already been initialized. * @pre The memory pool must already be initialized.
* @pre The array elements must be of the right size for the specified * @pre The array elements must be of the right size for the specified
* memory pool. * memory pool.
* @pre The array elements size must be a multiple of the alignment * @pre The array elements size must be a multiple of the alignment
@ -115,7 +115,7 @@ void chPoolLoadArray(memory_pool_t *mp, void *p, size_t n) {
/** /**
* @brief Allocates an object from a memory pool. * @brief Allocates an object from a memory pool.
* @pre The memory pool must be already been initialized. * @pre The memory pool must already be initialized.
* *
* @param[in] mp pointer to a @p memory_pool_t structure * @param[in] mp pointer to a @p memory_pool_t structure
* @return The pointer to the allocated object. * @return The pointer to the allocated object.
@ -144,7 +144,7 @@ void *chPoolAllocI(memory_pool_t *mp) {
/** /**
* @brief Allocates an object from a memory pool. * @brief Allocates an object from a memory pool.
* @pre The memory pool must be already been initialized. * @pre The memory pool must already be initialized.
* *
* @param[in] mp pointer to a @p memory_pool_t structure * @param[in] mp pointer to a @p memory_pool_t structure
* @return The pointer to the allocated object. * @return The pointer to the allocated object.
@ -164,7 +164,7 @@ void *chPoolAlloc(memory_pool_t *mp) {
/** /**
* @brief Releases an object into a memory pool. * @brief Releases an object into a memory pool.
* @pre The memory pool must be already been initialized. * @pre The memory pool must already be initialized.
* @pre The freed object must be of the right size for the specified * @pre The freed object must be of the right size for the specified
* memory pool. * memory pool.
* @pre The added object must be properly aligned. * @pre The added object must be properly aligned.
@ -189,7 +189,7 @@ void chPoolFreeI(memory_pool_t *mp, void *objp) {
/** /**
* @brief Releases an object into a memory pool. * @brief Releases an object into a memory pool.
* @pre The memory pool must be already been initialized. * @pre The memory pool must already be initialized.
* @pre The freed object must be of the right size for the specified * @pre The freed object must be of the right size for the specified
* memory pool. * memory pool.
* @pre The added object must be properly aligned. * @pre The added object must be properly aligned.
@ -228,7 +228,7 @@ void chGuardedPoolObjectInitAligned(guarded_memory_pool_t *gmp,
/** /**
* @brief Loads a guarded memory pool with an array of static objects. * @brief Loads a guarded memory pool with an array of static objects.
* @pre The guarded memory pool must be already been initialized. * @pre The guarded memory pool must already be initialized.
* @pre The array elements must be of the right size for the specified * @pre The array elements must be of the right size for the specified
* guarded memory pool. * guarded memory pool.
* @post The guarded memory pool contains the elements of the input array. * @post The guarded memory pool contains the elements of the input array.
@ -254,7 +254,7 @@ void chGuardedPoolLoadArray(guarded_memory_pool_t *gmp, void *p, size_t n) {
/** /**
* @brief Allocates an object from a guarded memory pool. * @brief Allocates an object from a guarded memory pool.
* @pre The guarded memory pool must be already been initialized. * @pre The guarded memory pool must already be initialized.
* *
* @param[in] gmp pointer to a @p guarded_memory_pool_t structure * @param[in] gmp pointer to a @p guarded_memory_pool_t structure
* @param[in] timeout the number of ticks before the operation timeouts, * @param[in] timeout the number of ticks before the operation timeouts,
@ -281,7 +281,7 @@ void *chGuardedPoolAllocTimeoutS(guarded_memory_pool_t *gmp,
/** /**
* @brief Allocates an object from a guarded memory pool. * @brief Allocates an object from a guarded memory pool.
* @pre The guarded memory pool must be already been initialized. * @pre The guarded memory pool must already be initialized.
* *
* @param[in] gmp pointer to a @p guarded_memory_pool_t structure * @param[in] gmp pointer to a @p guarded_memory_pool_t structure
* @param[in] timeout the number of ticks before the operation timeouts, * @param[in] timeout the number of ticks before the operation timeouts,
@ -307,7 +307,7 @@ void *chGuardedPoolAllocTimeout(guarded_memory_pool_t *gmp,
/** /**
* @brief Releases an object into a guarded memory pool. * @brief Releases an object into a guarded memory pool.
* @pre The guarded memory pool must be already been initialized. * @pre The guarded memory pool must already be initialized.
* @pre The freed object must be of the right size for the specified * @pre The freed object must be of the right size for the specified
* guarded memory pool. * guarded memory pool.
* @pre The added object must be properly aligned. * @pre The added object must be properly aligned.
@ -325,7 +325,7 @@ void chGuardedPoolFreeI(guarded_memory_pool_t *gmp, void *objp) {
/** /**
* @brief Releases an object into a guarded memory pool. * @brief Releases an object into a guarded memory pool.
* @pre The guarded memory pool must be already been initialized. * @pre The guarded memory pool must already be initialized.
* @pre The freed object must be of the right size for the specified * @pre The freed object must be of the right size for the specified
* guarded memory pool. * guarded memory pool.
* @pre The added object must be properly aligned. * @pre The added object must be properly aligned.