RPA Toolkit
documentaion changes
[rpatk.git] / rpa / doc / rpa_record.txt
1 /** \page rpa_record rparecord_t - Parse results.
2 The rpa_stat_parse populates an array(@ref rarray_t) with @ref rparecord_t 
3 structures. The parser generates starting and ending record of 
4 type @ref RPA_RECORD_START and @ref RPA_RECORD_END for every matching rule. 
5 If a rule A contains other rules B, C, D the records generated 
6 for B, C, D will appear between the starting and ending records of A. If B, C or D 
7 contain other rules, their records will be placed between the starting and ending 
8 records of B, C or D. If a rule doesn't contain any other rules, it will 
9 generate a start record immediately followed by an end record. The whole 
10 array of records forms an Abstract Syntax Tree (AST).
11
12
13 */