Quellcode durchsuchen

Documented mem functions.

woollybah vor 8 Jahren
Ursprung
Commit
bf007a19f8

+ 9 - 6
reference/functions/system/func_system_memalloc.rst

@@ -4,24 +4,28 @@
 MemAlloc
 ========
 
-MemAlloc - 
+MemAlloc - Allocate memory
 
 Description
 ===========
 
 .. code-block:: blitzmax
 
-    MemAlloc:Byte Ptr( size )
+    MemAlloc:Byte Ptr( size:Size_T )
 
-Allocate memory
+Allocates a block of ``size`` bytes of memory, returning a pointer to the start of the block.
+
+The content of the newly allocated block remains uninitialised, and therefore has indeterminate values.
 
 Parameters
 ==========
 
+* ``size`` - Size of the block of memory, in bytes.
+
 Return Values
 =============
 
-A new block of memory @size bytes long
+A new block of memory ``size`` bytes long.
 
 Examples
 ========
@@ -29,5 +33,4 @@ Examples
 See Also
 ========
 
-
-
+:ref:`func_system_memextend`, :ref:`func_system_memmove`, :ref:`func_system_memcopy`, :ref:`func_system_memfree`, :ref:`func_system_memclear`

+ 7 - 5
reference/functions/system/func_system_memclear.rst

@@ -4,20 +4,23 @@
 MemClear
 ========
 
-MemClear - 
+MemClear - Clear a block of memory to 0
 
 Description
 ===========
 
 .. code-block:: blitzmax
 
-    MemClear( mem:Byte Ptr,size )
+    MemClear( mem:Byte Ptr, size:Size_T )
 
-Clear a block of memory to 0
+Clears ``size`` bytes of the block of ``mem`` memory to zero.
 
 Parameters
 ==========
 
+* ``mem`` - A pointer to the block of memory to clear.
+* ``size`` - Number of bytes to set to 0.
+
 Return Values
 =============
 
@@ -29,5 +32,4 @@ Examples
 See Also
 ========
 
-
-
+:ref:`func_system_memalloc`, :ref:`func_system_memextend`, :ref:`func_system_memcopy`, :ref:`func_system_memmove`, :ref:`func_system_memfree`

+ 10 - 8
reference/functions/system/func_system_memextend.rst

@@ -4,26 +4,29 @@
 MemExtend
 =========
 
-MemExtend - 
+MemExtend - Extend a block of memory
 
 Description
 ===========
 
 .. code-block:: blitzmax
 
-    MemExtend:Byte Ptr( mem:Byte Ptr,size,new_size )
+    MemExtend:Byte Ptr( mem:Byte Ptr, size:Size_T, new_size:Size_T )
 
-Extend a block of memory
-An existing block of memory specified by @mem and @size is copied into a new block
-of memory @new_size bytes long. The existing block is released and the new block is returned.
+Copies an existing block of memory specified by ``mem`` and ``size`` into a new block
+of memory ``new_size`` bytes long. The existing block is released and the new block is returned.
 
 Parameters
 ==========
 
+* ``mem`` - A pointer to the source data to be copied.
+* ``size`` - The number of bytes to copy to the new block.
+* ``new_size`` - The total number of bytes to allocate to the new block.
+
 Return Values
 =============
 
-A new block of memory @new_size bytes long
+A new block of memory ``new_size`` bytes long.
 
 Examples
 ========
@@ -31,5 +34,4 @@ Examples
 See Also
 ========
 
-
-
+:ref:`func_system_memalloc`, :ref:`func_system_memmove`, :ref:`func_system_memcopy`, :ref:`func_system_memfree`, :ref:`func_system_memclear`

+ 6 - 5
reference/functions/system/func_system_memfree.rst

@@ -4,7 +4,7 @@
 MemFree
 =======
 
-MemFree - 
+MemFree - Free allocated memory
 
 Description
 ===========
@@ -13,12 +13,14 @@ Description
 
     MemFree( mem:Byte Ptr )
 
-Free allocated memory
-The memory specified by @mem must have been previously allocated by #MemAlloc or #MemExtend.
+A block of memory specified by ``mem``, having been previously allocated by :ref:`func_system_memalloc` or
+:ref:`func_system_memextend` is freed, making it available for further allocations.
 
 Parameters
 ==========
 
+* ``mem`` - A pointer to an allocated memory block.
+
 Return Values
 =============
 
@@ -30,5 +32,4 @@ Examples
 See Also
 ========
 
-
-
+:ref:`func_system_memalloc`, :ref:`func_system_memextend`, :ref:`func_system_memcopy`, :ref:`func_system_memmove`, :ref:`func_system_memclear`

+ 9 - 5
reference/functions/system/func_system_memmove.rst

@@ -4,20 +4,25 @@
 MemMove
 =======
 
-MemMove - 
+MemMove - Move a block of memory
 
 Description
 ===========
 
 .. code-block:: blitzmax
 
-    MemMove( dst:Byte Ptr,src:Byte Ptr,size )
+    MemMove( dst:Byte Ptr, src:Byte Ptr, size:Size_T )
 
-Copy a potentially overlapping block of memory
+Copies a potentially overlapping block of ``size`` bytes from the location pointed by ``src`` to the
+block of memory pointed to by ``dst``.
 
 Parameters
 ==========
 
+* ``dst`` - A pointer to the destination memory where the content is to be copied.
+* ``src`` - A pointer to the source data to be copied.
+* ``size`` - The number of bytes to copy.
+
 Return Values
 =============
 
@@ -29,5 +34,4 @@ Examples
 See Also
 ========
 
-
-
+:ref:`func_system_memalloc`, :ref:`func_system_memextend`, :ref:`func_system_memcopy`, :ref:`func_system_memfree`, :ref:`func_system_memclear`