mandoc/mdoc.3 - diff - 1.56

Return to mdoc.3 CVS log

Up to [cvsweb.bsd.lv] / mandoc

Diff for /mandoc/Attic/mdoc.3 between version 1.52 and 1.56

version 1.52, 2011/01/01 12:18:37

version 1.56, 2011/02/09 09:05:52

Line 34

Line 34

.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 *"

Line 96 See

Line 101 See

for details.

for details.

.El

.El

.Ss Functions

.Ss Functions

If

.Fn mdoc_addeqn ,

.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

.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 106 The

Line 125 The

.Fa data

.Fa data

pointer is passed to

pointer is passed to

.Fa msgs .

.Fa msgs .

Returns NULL on failure.

Always returns a valid pointer.

If non-NULL, the pointer must be freed with

The pointer must be freed with

.Fn mdoc_free .

.Fn mdoc_free .

.It Fn mdoc_reset

.It Fn mdoc_reset

Reset the parser for another parse routine.

Reset the parser for another parse routine.

Line 127 The input buffer

Line 146 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.

Note that if

.Fn mdoc_parseln

or

.Fn mdoc_endparse

return 0, the tree will be incomplete.

.It Fn mdoc_meta

.It Fn mdoc_meta

Returns the document's parsed meta-data.

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

.El

.Ss Variables

.Ss Variables

.Bl -ohang

.Bl -ohang