Updates function headers

Author: JujuAdams

Elephant.yyp

@@ -1,4 +1,10 @@
-/// @param target
+/// Makes an identical copy of the target. Unlike ElephantWrite(), this function ignores schemas and will copy
+/// all member variables and non-static methods. This function will recreate constructed structs appropriately
+/// and will also correctly duplicate circular references.
+/// 
+/// @return  A copy of the target data
+/// 
+/// @param target  Data to duplicate
 
 function ElephantDuplicate(_target)
 {

scripts/ElephantDuplicate/ElephantDuplicate.gml

@@ -1,4 +1,8 @@
-/// @param target
+/// As ElephantWrite(), but returns a base64-encoded string. This function also compresses the buffer.
+/// 
+/// @return base64-encoded string
+/// 
+/// @param target  Data to serialize
 
 function ElephantExportString(_target)
 {

scripts/ElephantExportString/ElephantExportString.gml

@@ -1,4 +1,8 @@
-/// @param string
+/// As ElephantRead(), but takes a string rather than a buffer as input.
+/// 
+/// @return  The data that was encoded
+/// 
+/// @param string  base64-encoded string, as created by ElephantExportString()
 
 function ElephantImportString(_string)
 {

scripts/ElephantImportString/ElephantImportString.gml

@@ -1,4 +1,11 @@
-/// @param buffer
+/// Deserializes Elephant data from a buffer, starting at the buffer_tell() point. This function uses
+/// buffer_read() and will move the buffer head as it reads data. This function calls ELEPHANT_PRE_READ_METHOD
+/// and ELEPHANT_POST_READ_METHOD for constructed structs, and ELEPHANT_IS_DESERIALIZING is set to <true>.
+/// ELEPHANT_SCHEMA_VERSION will contain the constructor schema version that Elephant found in the source data.
+/// 
+/// @return  The data that was encoded
+/// 
+/// @param buffer  The buffer to read from
 
 function ElephantRead(_buffer)
 {

scripts/ElephantRead/ElephantRead.gml

@@ -1,5 +1,13 @@
-/// @param target
-/// @param [buffer]
+/// Serializes the given target data and writes it to the given buffer, starting at the buffer_tell() position.
+/// This function uses buffer_write() and will move the buffer head as it writes. If no buffer is provided then
+/// a new buffer is created that fits the serialized data. This function calls ELEPHANT_PRE_WRITE_METHOD and
+/// ELEPHANT_POST_WRITE_METHOD for constructed structs, and ELEPHANT_IS_DESERIALIZING is set to <false>.
+/// ELEPHANT_SCHEMA_VERSION will contain the constructor schema version that Elephant is using to serialize data.
+/// 
+/// @return  Buffer, either the buffer passed into the function or a buffer the function created itself
+/// 
+/// @param target    Data to serialize
+/// @param [buffer]  Optional, the buffer to write to. If no buffer is provided then one is created automatically
 
 function ElephantWrite()
 {