=================================================================== RCS file: /cvs/mandoc/Attic/mdoc.3,v retrieving revision 1.24 retrieving revision 1.27 diff -u -p -r1.24 -r1.27 --- mandoc/Attic/mdoc.3 2009/03/26 16:23:22 1.24 +++ mandoc/Attic/mdoc.3 2009/04/12 19:19:57 1.27 @@ -1,4 +1,4 @@ -.\" $Id: mdoc.3,v 1.24 2009/03/26 16:23:22 kristaps Exp $ +.\" $Id: mdoc.3,v 1.27 2009/04/12 19:19:57 kristaps Exp $ .\" .\" Copyright (c) 2009 Kristaps Dzonsons .\" @@ -16,8 +16,8 @@ .\" TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR .\" PERFORMANCE OF THIS SOFTWARE. .\" -.Dd $Mdocdate: March 26 2009 $ -.Dt mdoc 3 +.Dd $Mdocdate: April 12 2009 $ +.Dt MDOC 3 .Os .\" SECTION .Sh NAME @@ -36,7 +36,7 @@ .Vt extern const char * const * mdoc_argnames; .Ft "struct mdoc *" .Fn mdoc_alloc "void *data" "int pflags" "const struct mdoc_cb *cb" -.Ft void +.Ft int .Fn mdoc_reset "struct mdoc *mdoc" .Ft void .Fn mdoc_free "struct mdoc *mdoc" @@ -56,14 +56,7 @@ library parses lines of .Xr mdoc 7 input (and .Em only -mdoc) into an abstract syntax tree that generalises the semantic -annotation of its input. Common front-ends for -.Nm -are -.Xr mdocterm 1 , -.Xr mdoclint 1 -and -.Xr mdoctree 1 . +mdoc) into an abstract syntax tree (AST). .\" PARAGRAPH .Pp In general, applications initiate a parsing sequence with @@ -140,7 +133,8 @@ Returns NULL on failure. If non-NULL, the pointer mus .It Fn mdoc_reset Reset the parser for another parse routine. After its use, .Fn mdoc_parseln -behaves as if invoked for the first time. +behaves as if invoked for the first time. If it returns 0, memory could +not be allocated. .\" LIST-ITEM .It Fn mdoc_free Free all resources of a parser. The pointer is no longer valid after @@ -227,9 +221,7 @@ fields), its position in the tree (the .Va next and .Va prev -fields) and type-specific data (the -.Va data -field). +fields) and some type-specific data. .\" PARAGRAPH .Pp The tree itself is arranged according to the following normal form, @@ -281,7 +273,7 @@ size_t len; int line; line = 1; -mdoc = mdoc_alloc(NULL, NULL); +mdoc = mdoc_alloc(NULL, 0, NULL); while ((buf = fgetln(fp, &len))) { buf[len - 1] = '\\0';