Usage information is added
authorteodor <teodor>
Thu, 2 Oct 2008 15:44:13 +0000 (15:44 +0000)
committerteodor <teodor>
Thu, 2 Oct 2008 15:44:13 +0000 (15:44 +0000)
template.h

index 0e12052..a2d7e39 100644 (file)
@@ -28,6 +28,9 @@
  */
 
 /******************************************************************************
  */
 
 /******************************************************************************
+ *                         Html template library                              *
+ ******************************************************************************
+ ******************************************************************************
  *                                  SYNTAX                                    *
  ******************************************************************************
  * <% EXPRESSION , "FORMAT"] [# "DEFAULTVALUE"] [|(h|u)]%>
  *                                  SYNTAX                                    *
  ******************************************************************************
  * <% EXPRESSION , "FORMAT"] [# "DEFAULTVALUE"] [|(h|u)]%>
@@ -74,7 +77,7 @@
  * <# comment #>
  *
  ******************************************************************************
  * <# comment #>
  *
  ******************************************************************************
- *                                C-Interface
+ *                                C-Interface                                 *
  ******************************************************************************
  * - setTemplateValueInt
  *   setTemplateValueString
  ******************************************************************************
  * - setTemplateValueInt
  *   setTemplateValueString
  *  setTemplateValueBool("outerLoop.var1");
  *     addTemplateRow("innerLoop");
  *  setTemplateValueBool("outerLoop.innerLoop.var2");
  *  setTemplateValueBool("outerLoop.var1");
  *     addTemplateRow("innerLoop");
  *  setTemplateValueBool("outerLoop.innerLoop.var2");
+ *
+ ******************************************************************************
+ *                               Memory management                            * 
+ ******************************************************************************
+ * Unfortunatly, I'm too lazy to unify memory usage by several pieces
+ * in library. So, library uses mixed plain malloc and memory context
+ * concepts (tmalloc.h).
+ * To work with library it's needed to allocate persitent memory context
+ * for initTemplate() call and temprorary memory context for usual work.
+ * after printTemplate is called it's needed to call resetTemplate() and 
+ * then resetMemoryContext() for second context. 
  * 
  ******************************************************************************/
 
  * 
  ******************************************************************************/