summaryrefslogtreecommitdiffstats
path: root/man.3
diff options
context:
space:
mode:
authorKristaps Dzonsons <kristaps@bsd.lv>2011-01-03 11:31:26 +0000
committerKristaps Dzonsons <kristaps@bsd.lv>2011-01-03 11:31:26 +0000
commit5be7a4ded8b88fd7df89348083d8e985282780fc (patch)
treeaccee8bf52f3a9562689f4ff97a617c2d6eb7f5c /man.3
parentd5976ecf949530abbe4672ca2ab66a66cc00ddec (diff)
downloadmandoc-5be7a4ded8b88fd7df89348083d8e985282780fc.tar.gz
Same treatment for MAN_HALT as for MDOC_HALT.
Diffstat (limited to 'man.3')
-rw-r--r--man.329
1 files changed, 12 insertions, 17 deletions
diff --git a/man.3 b/man.3
index 4d327b62..1ea19b64 100644
--- a/man.3
+++ b/man.3
@@ -105,6 +105,16 @@ See
for details.
.El
.Ss Functions
+If
+.Fn man_addspan ,
+.Fn man_parseln ,
+or
+.Fn man_endparse
+return 0, calls to any function but
+.Fn man_reset
+or
+.Fn man_free
+will raise an assertion.
.Bl -ohang
.It Fn man_addspan
Add a table span to the parsing stream.
@@ -115,8 +125,8 @@ The
.Fa data
pointer is passed to
.Fa msgs .
-Returns NULL on failure.
-If non-NULL, the pointer must be freed with
+Always returns a valid pointer.
+The pointer must be freed with
.Fn man_free .
.It Fn man_reset
Reset the parser for another parse routine.
@@ -135,26 +145,11 @@ The input buffer
is modified by this function.
.It Fn man_endparse
Signals that the parse is complete.
-Note that if
-.Fn man_endparse
-is called subsequent to
-.Fn man_node ,
-the resulting tree is incomplete.
Returns 0 on failure, 1 on success.
.It Fn man_node
Returns the first node of the parse.
-Note that if
-.Fn man_parseln
-or
-.Fn man_endparse
-return 0, the tree will be incomplete.
.It Fn man_meta
Returns the document's parsed meta-data.
-If this information has not yet been supplied or
-.Fn man_parseln
-or
-.Fn man_endparse
-return 0, the data will be incomplete.
.El
.Ss Variables
The following variables are also defined: