version 1.53, 2011/01/03 11:27:32 |
version 1.57, 2011/02/09 09:18:15 |
|
|
.Os |
.Os |
.Sh NAME |
.Sh NAME |
.Nm mdoc , |
.Nm mdoc , |
|
.Nm mdoc_addeqn , |
|
.Nm mdoc_addspan , |
.Nm mdoc_alloc , |
.Nm mdoc_alloc , |
.Nm mdoc_endparse , |
.Nm mdoc_endparse , |
.Nm mdoc_free , |
.Nm mdoc_free , |
|
|
.Vt extern const char * const * mdoc_macronames; |
.Vt extern const char * const * mdoc_macronames; |
.Vt extern const char * const * mdoc_argnames; |
.Vt extern const char * const * mdoc_argnames; |
.Ft int |
.Ft int |
.Fo mdoc_addspan |
.Fo mdoc_addeqn |
.Fa "struct mdoc *mdoc" |
.Fa "struct mdoc *mdoc" |
|
.Fa "const struct eqn *eqn" |
|
.Fc |
|
.Ft int |
|
.Fo mdoc_addspan |
|
.Fa "struct mdoc *mdoc" |
.Fa "const struct tbl_span *span" |
.Fa "const struct tbl_span *span" |
.Fc |
.Fc |
.Ft "struct mdoc *" |
.Ft "struct mdoc *" |
|
|
.El |
.El |
.Ss Functions |
.Ss Functions |
If |
If |
|
.Fn mdoc_addeqn , |
.Fn mdoc_addspan , |
.Fn mdoc_addspan , |
.Fn mdoc_parseln , |
.Fn mdoc_parseln , |
or |
or |
|
|
.Fn mdoc_free |
.Fn mdoc_free |
will raise an assertion. |
will raise an assertion. |
.Bl -ohang |
.Bl -ohang |
|
.It Fn mdoc_addeqn |
|
Add an equation to the parsing stream. |
|
Returns 0 on failure, 1 on success. |
.It Fn mdoc_addspan |
.It Fn mdoc_addspan |
Add a table span to the parsing stream. |
Add a table span to the parsing stream. |
Returns 0 on failure, 1 on success. |
Returns 0 on failure, 1 on success. |
Line 137 The input buffer |
|
Line 148 The input buffer |
|
is modified by this function. |
is modified by this function. |
.It Fn mdoc_endparse |
.It Fn mdoc_endparse |
Signals that the parse is complete. |
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. |
Returns 0 on failure, 1 on success. |
.It Fn mdoc_node |
.It Fn mdoc_node |
Returns the first node of the parse. |
Returns the first node of the parse. |