added general comments to the functions in cleanup.h

Author: Srivat97

utils/vqm2blif/src/base/cleanup.h

@@ -19,8 +19,33 @@ extern int buffers_elim, inverts_elim, oneluts_elim;
 
 void netlist_cleanup (t_module* module);
 
+/*
+*	Function: remove_node
+*	
+*	Removes a specific node within a modules node list (node array)
+*
+*	Parameters:
+*		node  - a pointer to the node to remove from the module node list (node array)
+*		nodes - The module node list containing all nodes (node array) 
+*		original_num_nodes - an integer that represents the total number of nodes within the module node list (node array)
+*		
+*	returns: If successful, then nothing is returned. 
+*		     If the node to remove was not found, and assertion is raised. 
+*
+*/
 void remove_node ( t_node* node, t_node** nodes, int original_num_nodes );
 
+/*
+*	Function: reorganize_module_node_list
+*	
+*	This function fixes a module node list (node array) that has elements
+*   within it removed. THe removed elements create gaps within the array and
+*	this function fills in those gaps so that the array is continuous.
+*
+*	Parameters:
+*		module - the module that contains a node list with elemets within it deleted 
+*		
+*/
 void reorganize_module_node_list(t_module* module);
 
 //============================================================================================