aboutsummaryrefslogtreecommitdiffstats
path: root/src/chheap.c
diff options
context:
space:
mode:
authorgdisirio <gdisirio@35acf78f-673a-0410-8e92-d51de3d6d3f4>2008-10-17 18:33:35 +0000
committergdisirio <gdisirio@35acf78f-673a-0410-8e92-d51de3d6d3f4>2008-10-17 18:33:35 +0000
commit1d23eb296156769cff3e41bd7026db1cd2538664 (patch)
tree512bbaa17560196c09dcce171bcb28a367838542 /src/chheap.c
parent3d3e5728aa1d14444b99732426d36f6375013727 (diff)
downloadChibiOS-1d23eb296156769cff3e41bd7026db1cd2538664.tar.gz
ChibiOS-1d23eb296156769cff3e41bd7026db1cd2538664.tar.bz2
ChibiOS-1d23eb296156769cff3e41bd7026db1cd2538664.zip
git-svn-id: svn://svn.code.sf.net/p/chibios/svn/trunk@474 35acf78f-673a-0410-8e92-d51de3d6d3f4
Diffstat (limited to 'src/chheap.c')
-rw-r--r--src/chheap.c6
1 files changed, 3 insertions, 3 deletions
diff --git a/src/chheap.c b/src/chheap.c
index 7a2f0ccac..08ead3411 100644
--- a/src/chheap.c
+++ b/src/chheap.c
@@ -98,8 +98,8 @@ void chHeapInit(void) {
* @param size the size of the block to be allocated. Note that the allocated
* block may be a bit bigger than the requested size for alignment
* and fragmentation reasons.
- * @return a pointer to the allocated block or \p NULL if the block cannot be
- * allocated.
+ * @return A pointer to the allocated block.
+ * @retval NULL if the block cannot be allocated.
*/
void *chHeapAlloc(size_t size) {
struct header *qp, *hp, *fp;
@@ -187,7 +187,7 @@ void chHeapFree(void *p) {
* Determines the heap status.
* @param sizep pointer to a variable that will receive the total fragmented
* free space
- * @return the number of fragments in the heap
+ * @return The number of fragments in the heap.
* @note This function is meant to be used in the test suite, it should not be
* really useful for the application code.
* @note This function is not implemented when the \p CH_USE_MALLOC_HEAP