reaching comment perfection

--HG--
extra : convert_revision : svn%3A39bc706e-5318-0410-9160-8a85361fbb7c/trunk%40154

sourcepawn/include/sp_vm_api.h

@@ -19,7 +19,7 @@ namespace SourcePawn
 		* Loads a named file from a file pointer.  
 		* Using this means base memory will be allocated by the VM.
 		* 
-		* @param fp		File pointer.  May be at any offset.  Not closed on return.
+		* @param fp			File pointer.  May be at any offset.  Not closed on return.
 		* @param err		Optional error code pointer.
 		* @return			A new plugin structure.
 		*/	
@@ -69,7 +69,7 @@ namespace SourcePawn
 		/**
 		 * Frees memory allocated with BaseAlloc.
 		 *
-		 * @param mem		Memory address to free.
+		 * @param memory	Memory address to free.
 		 */
 		virtual void BaseFree(void *memory) =0;
 
@@ -84,7 +84,7 @@ namespace SourcePawn
 		/**
 		 * Frees executable memory.
 		 *
-		 * @param mem		Address to free.
+		 * @param address	Address to free.
 		 */
 		virtual void ExecFree(void *address) =0;
 	};

sourcepawn/include/sp_vm_context.h

@@ -154,7 +154,7 @@ namespace SourcePawn
 		 * Gets public function info by index.
 		 * 
 		 * @param index			Public function index number.
-		 * @param pblic			Optionally filled with pointer to public structure.
+		 * @param public		Optionally filled with pointer to public structure.
 		 */
 		virtual int GetPublicByIndex(uint32_t index, sp_public_t **publicptr) =0;
 
@@ -177,8 +177,6 @@ namespace SourcePawn
 		 *
 		 * @param name			Name of pubvar
 		 * @param index			Optionally filled with pubvar index number.
-		 * @param local_addr	Optionally filled with local address offset.
-		 * @param phys_addr		Optionally filled with relocated physical address.
 		 */
 		virtual int FindPubvarByName(const char *name, uint32_t *index) =0;
 
@@ -255,8 +253,7 @@ namespace SourcePawn
 		 *
 		 * @param local_addr	Filled with local address to release.
 		 * @param phys_addr		Optionally filled with physical address of new array.
-		 * @param array			Cell array to copy.
-		 * @param numcells		Number of cells in the array to copy.
+		 * @param string		Source string to push.
 		 */
 		virtual int PushString(cell_t *local_addr, cell_t **phys_addr, const char *string) =0;
 
@@ -278,6 +275,7 @@ namespace SourcePawn
 		 * 
 		 * @param natives		Array of natives.
 		 * @param num			Number of natives in array.
+		 * @param overwrite		Toggles overwrite.
 		 */
 		virtual int BindNatives(sp_nativeinfo_t *natives, unsigned int num, int overwrite) =0;
 

sourcepawn/vm/sp_vm_engine.h

@@ -14,7 +14,7 @@ namespace SourcePawn
 		 * Note: The file handle position may be undefined on entry, and is
 		 *  always undefined on conclusion.
 		 * 
-		 * @param fp			File pointer.  May be at any offset.  Not closed on return.
+		 * @param fp		File pointer.  May be at any offset.  Not closed on return.
 		 * @param err		Optional error code pointer.
 		 * @return			A new plugin structure.
 		 */	
@@ -64,11 +64,10 @@ namespace SourcePawn
 		/**
 		 * Frees memory allocated with BaseAlloc.
 		 *
-		 * @param mem		Memory address to free.
+		 * @param memory	Memory address to free.
 		 */
 		void BaseFree(void *memory);
 
-
 		/**
 		 * Allocates executable memory.
 		 *
@@ -80,7 +79,7 @@ namespace SourcePawn
 		/**
 		 * Frees executable memory.
 		 *
-		 * @param mem		Address to free.
+		 * @param address	Address to free.
 		 */
 		void ExecFree(void *address);
 	};