diff --git a/c/tex_parser/tex_parser.h b/c/tex_parser/tex_parser.h index 60c8eb8..4251586 100644 --- a/c/tex_parser/tex_parser.h +++ b/c/tex_parser/tex_parser.h @@ -8,15 +8,15 @@ #define TEX_PARSER_DOMAIN 0 /** - * enum tex_parser_error - the LaTeX parser error code + * enum tex_parser_error - the LaTeX parser error codes * * @TEX_PARSER_NOERROR: Default state indicates no error. - * @TEX_PARSER_ERROR_UNKNOWN: - * @TEX_PARSER_ERROR_STACK: - * @TEX_PARSER_ERROR_PLACE_UNKNOWN: - * @TEX_PARSER_ERROR_UNEXPECTED_SYMBOL: + * @TEX_PARSER_ERROR_UNKNOWN: Uncontrolled error happen + * @TEX_PARSER_ERROR_STACK: Stack overflow + * @TEX_PARSER_ERROR_PLACE_UNKNOWN: Unknown place (internal error) + * @TEX_PARSER_ERROR_UNEXPECTED_SYMBOL: Unexpected symbol for current place * - * Need some description here... + * Defines parser error codes, @TEX_PARSER_NOERROR = %0 is equivalent to no errors. */ enum tex_parser_error { TEX_PARSER_NOERROR = 0, @@ -29,9 +29,12 @@ enum tex_parser_error { /** * struct tex_table_row_s - LaTeX table row * - * @cells: - * @row_line: + * @over_line: Text over row (\hline for ex.) + * @cells: Row cells + * @under_line: Text under row (\cline{2-4} for ex.) * + * @over_line, @cells, @under_line uses zalloc*() functions which stores + * array dimensions. */ struct tex_table_row_s { char *over_line; // \hline, \cline{4-5} etc. @@ -42,31 +45,40 @@ struct tex_table_row_s { /** * struct tex_table_s - LaTeX table * - * @document_offset: - * @document_size: - * @id: - * @col_props: - * @head_table: - * @foot_table: - * @main_table: + * @document_offset: Table offset (in symbols) in the LaTeX document + * @document_size: Table size (in symbols) in the LaTeX document + * @id: Id in report generator context (Request.Drossel1.Table1 for ex.) + * @col_props: Column properties devided by '>' symbol + * @head_table: Top rows devided by & and automaticaly added on page break + * @foot_table: Bottom rows devided by & and automaticaly added on page break + * @main_table: Central rows which can be devided horizontally and vertically + * + * @col_props, @head_table, @foot_table, @main_table uses zalloc*() functions to + * determine array dimensions. */ struct tex_table_s { - size_t document_offset; // offset (in sybmols) in the LaTeX document - size_t document_size; // size (in symbols) in the LaTeX document - char *id; // "Drossel1.Table1" - char **col_props; // divided by > - struct tex_table_row_s *head_table; // divided by & - struct tex_table_row_s *foot_table; // divided by & and \tabularnewline - struct tex_table_row_s *main_table; // divided by & and \tabularnewline + size_t document_offset; + size_t document_size; + char *id; + char **col_props; + struct tex_table_row_s *head_table; + struct tex_table_row_s *foot_table; + struct tex_table_row_s *main_table; }; /** * struct tex_graphics - LaTeX graphics * - * @something: + * @prestr: Preceding string + * @path: Path to image file + * @poststr: Descendant string + * + * Need some description here... */ struct tex_graphics { - void *something; + char *prestr; + char *path; + char *poststr; }; /**