=================================================================== RCS file: /cvsrepo/anoncvs/cvs/src/usr.bin/mandoc/Attic/mdoc.3,v retrieving revision 1.15 retrieving revision 1.16 diff -c -r1.15 -r1.16 *** src/usr.bin/mandoc/Attic/mdoc.3 2011/01/04 22:28:17 1.15 --- src/usr.bin/mandoc/Attic/mdoc.3 2011/01/09 13:16:48 1.16 *************** *** 1,4 **** ! .\" $Id: mdoc.3,v 1.15 2011/01/04 22:28:17 schwarze Exp $ .\" .\" Copyright (c) 2009, 2010, 2011 Kristaps Dzonsons .\" Copyright (c) 2010 Ingo Schwarze --- 1,4 ---- ! .\" $Id: mdoc.3,v 1.16 2011/01/09 13:16:48 schwarze Exp $ .\" .\" Copyright (c) 2009, 2010, 2011 Kristaps Dzonsons .\" Copyright (c) 2010 Ingo Schwarze *************** *** 15,21 **** .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. .\" ! .Dd $Mdocdate: January 4 2011 $ .Dt MDOC 3 .Os .Sh NAME --- 15,21 ---- .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. .\" ! .Dd $Mdocdate: January 9 2011 $ .Dt MDOC 3 .Os .Sh NAME *************** *** 96,101 **** --- 96,111 ---- for details. .El .Ss Functions + If + .Fn mdoc_addspan , + .Fn mdoc_parseln , + or + .Fn mdoc_endparse + return 0, calls to any function but + .Fn mdoc_reset + or + .Fn mdoc_free + will raise an assertion. .Bl -ohang .It Fn mdoc_addspan Add a table span to the parsing stream. *************** *** 106,113 **** .Fa data pointer is passed to .Fa msgs . ! Returns NULL on failure. ! If non-NULL, the pointer must be freed with .Fn mdoc_free . .It Fn mdoc_reset Reset the parser for another parse routine. --- 116,123 ---- .Fa data pointer is passed to .Fa msgs . ! Always returns a valid pointer. ! The pointer must be freed with .Fn mdoc_free . .It Fn mdoc_reset Reset the parser for another parse routine. *************** *** 127,152 **** is modified by this function. .It Fn mdoc_endparse Signals that the parse is complete. - Note that if - .Fn mdoc_endparse - is called subsequent to - .Fn mdoc_node , - the resulting tree is incomplete. Returns 0 on failure, 1 on success. .It Fn mdoc_node Returns the first node of the parse. - Note that if - .Fn mdoc_parseln - or - .Fn mdoc_endparse - return 0, the tree will be incomplete. .It Fn mdoc_meta Returns the document's parsed meta-data. - If this information has not yet been supplied or - .Fn mdoc_parseln - or - .Fn mdoc_endparse - return 0, the data will be incomplete. .El .Ss Variables .Bl -ohang --- 137,147 ----