version 1.49, 2010/08/20 01:02:07 |
version 1.50, 2010/10/10 09:47:05 |
|
|
.Fn mdoc_reset |
.Fn mdoc_reset |
function may be used in order to reset the parser for another input |
function may be used in order to reset the parser for another input |
sequence. |
sequence. |
See the |
|
.Sx EXAMPLES |
|
section for a simple example. |
|
.Pp |
|
This section further defines the |
|
.Sx Types , |
|
.Sx Functions |
|
and |
|
.Sx Variables |
|
available to programmers. |
|
Following that, the |
|
.Sx Abstract Syntax Tree |
|
section documents the output tree. |
|
.Ss Types |
.Ss Types |
Both functions (see |
|
.Sx Functions ) |
|
and variables (see |
|
.Sx Variables ) |
|
may use the following types: |
|
.Bl -ohang |
.Bl -ohang |
.It Vt struct mdoc |
.It Vt struct mdoc |
An opaque type defined in |
An opaque type. |
.Pa mdoc.c . |
|
Its values are only used privately within the library. |
Its values are only used privately within the library. |
.It Vt struct mdoc_node |
.It Vt struct mdoc_node |
A parsed node. |
A parsed node. |
Defined in |
|
.Pa mdoc.h . |
|
See |
See |
.Sx Abstract Syntax Tree |
.Sx Abstract Syntax Tree |
for details. |
for details. |
.It Vt mandocmsg |
|
A function callback type defined in |
|
.Pa mandoc.h . |
|
.El |
.El |
.Ss Functions |
.Ss Functions |
Function descriptions follow: |
|
.Bl -ohang |
.Bl -ohang |
.It Fn mdoc_alloc |
.It Fn mdoc_alloc |
Allocates a parsing structure. |
Allocates a parsing structure. |
|
|
return 0, the data will be incomplete. |
return 0, the data will be incomplete. |
.El |
.El |
.Ss Variables |
.Ss Variables |
The following variables are also defined: |
|
.Bl -ohang |
.Bl -ohang |
.It Va mdoc_macronames |
.It Va mdoc_macronames |
An array of string-ified token names. |
An array of string-ified token names. |
Line 354 parsed(mdoc, node); |
|
Line 328 parsed(mdoc, node); |
|
mdoc_free(mdoc); |
mdoc_free(mdoc); |
.Ed |
.Ed |
.Pp |
.Pp |
Please see |
To compile this, execute |
|
.Pp |
|
.D1 % cc main.c libmdoc.a libmandoc.a |
|
.Pp |
|
where |
.Pa main.c |
.Pa main.c |
in the source archive for a rigorous reference. |
is the example file. |
.Sh SEE ALSO |
.Sh SEE ALSO |
.Xr mandoc 1 , |
.Xr mandoc 1 , |
.Xr mdoc 7 |
.Xr mdoc 7 |