Annotation of mandoc/mdoc.3, Revision 1.1
1.1 ! kristaps 1: .\"
! 2: .Dd $Mdocdate$
! 3: .Dt mdoc 3
! 4: .Os
! 5: .\"
! 6: .Sh NAME
! 7: .Nm mdoc_alloc ,
! 8: .Nm mdoc_parseln ,
! 9: .Nm mdoc_endparse ,
! 10: .Nm mdoc_result ,
! 11: .Nm mdoc_free
! 12: .Nd mdoc macro compiler
! 13: .\"
! 14: .Sh SYNOPSIS
! 15: .In mdoc.h
! 16: .Ft "struct mdoc *"
! 17: .Fn mdoc_alloc "void *data" "const struct mdoc_cb *cb"
! 18: .Ft void
! 19: .Fn mdoc_free "struct mdoc *"
! 20: .Ft int
! 21: .Fn mdoc_parseln "struct mdoc *" "int" "char *buf"
! 22: .Ft "const struct mdoc_node *"
! 23: .Fn mdoc_result "struct mdoc *"
! 24: .Ft int
! 25: .Fn mdoc_endparse "struct mdoc *"
! 26: .\"
! 27: .Sh DESCRIPTION
! 28: The
! 29: .Nm mdoc
! 30: library parses lines of mdoc-macro text into an abstract syntax tree.
! 31: In general, applications initiate a parsing sequence with
! 32: .Fn mdoc_alloc ,
! 33: parse each line in a document with
! 34: .Fn mdoc_parseln ,
! 35: close the parsing session with
! 36: .Fn mdoc_endparse ,
! 37: operate over the syntax tree returned by
! 38: .Fn mdoc_result ,
! 39: then free all allocated memory with
! 40: .Fn mdoc_free .
! 41: See the
! 42: .Sx EXAMPLES
! 43: section for a full example.
! 44: .\" The following requests should be uncommented and used where appropriate.
! 45: .\" This next request is for sections 2, 3, and 9 function return values only.
! 46: .\" .Sh RETURN VALUES
! 47: .\" .Sh EXAMPLES
! 48: .\" The next request is for sections 2, 3, and 9 error and signal handling only.
! 49: .\" .Sh ERRORS
! 50: .\" .Sh SEE ALSO
! 51: .\" .Xr foobar 1
! 52: .\" .Sh STANDARDS
! 53: .\" .Sh HISTORY
! 54: .\" .Sh AUTHORS
! 55: .\" .Sh CAVEATS
! 56: .\" .Sh BUGS
CVSweb