RPA Toolkit
documentaion changes
authorMartin Stoilov <martin@rpasearch.com>
Tue, 5 Jul 2011 06:18:20 +0000 (23:18 -0700)
committerMartin Stoilov <martin@rpasearch.com>
Tue, 5 Jul 2011 06:18:20 +0000 (23:18 -0700)
doc/doxygen/rpa.cfg
rpa/doc/main.txt
rpa/doc/rpa_dbex.txt
rpa/doc/rpa_record.txt [new file with mode: 0644]
rpa/doc/rpa_stat.txt [new file with mode: 0644]
rpa/doc/rpatk_build.txt

index a0981a8..8ff7650 100644 (file)
@@ -101,6 +101,8 @@ INPUT                  = ../../rpa/rpadbex.h \
                          ../../rpa/doc/rpa_intro.txt \
                          ../../rpa/doc/rpa_bnf.txt \
                          ../../rpa/doc/rpa_dbex.txt \
+                         ../../rpa/doc/rpa_stat.txt \
+                         ../../rpa/doc/rpa_record.txt \
                          ../../rpa/doc/introduction.txt 
 
 INPUT_ENCODING         = UTF-8
index 68dbc0b..cdd396f 100644 (file)
@@ -6,5 +6,7 @@
 - @subpage rpa_main "Regular Pattern Analyzer"
        - @subpage rpa_bnf      
        - @subpage rpa_dbex
+       - @subpage rpa_stat
+       - @subpage rpa_record
 */
 
index 6083820..14c03f5 100644 (file)
@@ -1,4 +1,4 @@
-/** \page rpa_dbex Loading and compiling BNF productions.
+/** \page rpa_dbex rpadbex_t - Loading and compiling BNF rules.
 To use a BNF schema for parsing, searching or matching you must first load and
 compile the BNF schema using the @ref rpadbex_t API.
 
diff --git a/rpa/doc/rpa_record.txt b/rpa/doc/rpa_record.txt
new file mode 100644 (file)
index 0000000..3ab06e3
--- /dev/null
@@ -0,0 +1,13 @@
+/** \page rpa_record rparecord_t - Parse results.
+The rpa_stat_parse populates an array(@ref rarray_t) with @ref rparecord_t 
+structures. The parser generates starting and ending record of 
+type @ref RPA_RECORD_START and @ref RPA_RECORD_END for every matching rule. 
+If a rule A contains other rules B, C, D the records generated 
+for B, C, D will appear between the starting and ending records of A. If B, C or D 
+contain other rules, their records will be placed between the starting and ending 
+records of B, C or D. If a rule doesn't contain any other rules, it will 
+generate a start record immediately followed by an end record. The whole 
+array of records forms an Abstract Syntax Tree (AST).
+
+
+*/
diff --git a/rpa/doc/rpa_stat.txt b/rpa/doc/rpa_stat.txt
new file mode 100644 (file)
index 0000000..576ae77
--- /dev/null
@@ -0,0 +1,10 @@
+/** \page rpa_stat rpastat_t - Parsing, searching or matching.
+To parse, search or match you must use @ref rpastat_t API.
+- 1. Create @ref rpastat_t object with @rpa_stat_create.
+- 2. To parse, search or match use:
+       - @ref rpa_stat_parse
+       - @ref rpa_stat_scan
+       - @ref rpa_stat_match
+       
+       
+*/
\ No newline at end of file
index c51cc1a..66ec4d5 100644 (file)
@@ -1,4 +1,4 @@
-/** @page rpatk_build Build from source
+/** @page rpatk_build Build
 
 <h2>Linux</h2>
 To build the source tree and install on Linux: