diff options
author | Kristaps Dzonsons <kristaps@bsd.lv> | 2011-04-09 15:53:48 +0000 |
---|---|---|
committer | Kristaps Dzonsons <kristaps@bsd.lv> | 2011-04-09 15:53:48 +0000 |
commit | 3f2faf77e49f7fecc520f6de20125c7ea9b9f134 (patch) | |
tree | 520bf40a12faad7c3a007dd80744887c835bbe1c /mandoc.3 | |
parent | 7946e286eaa9089a5e43364c3b70ddbbeb5e7224 (diff) | |
download | mandoc-3f2faf77e49f7fecc520f6de20125c7ea9b9f134.tar.gz |
Skeleton of documentation functions, types, and variables in mandoc.h.
Diffstat (limited to 'mandoc.3')
-rw-r--r-- | mandoc.3 | 41 |
1 files changed, 41 insertions, 0 deletions
@@ -20,6 +20,7 @@ .Os .Sh NAME .Nm mandoc , +.Nm mandoc_escape , .Nm man_meta , .Nm man_node , .Nm mdoc_meta , @@ -36,6 +37,12 @@ .In man.h .In mdoc.h .In mandoc.h +.Ft "enum mandoc_esc" +.Fo mandoc_escape +.Fa "const char **in" +.Fa "const char **seq" +.Fa "int *len" +.Fc .Ft "const struct man_meta *" .Fo man_meta .Fa "const struct man *man" @@ -131,6 +138,40 @@ or invoke .Fn mparse_reset and parse new files. .El +.Sh REFERENCE +This section documents the functions, types, and variables available +via +.In mandoc.h . +.Ss Types +.Bl -ohang +.It Vt "enum mandoc_esc" +.It Vt "enum mandocerr" +.It Vt "enum mandoclevel" +.It Vt "enum mparset" +.It Vt "struct mparse" +.It Vt "mandocmsg" +.El +.Ss Functions +.Bl -ohang +.It Fn mandoc_escape +.It Fn man_meta +.It Fn man_node +.It Fn mdoc_meta +.It Fn mdoc_node +.It Fn mparse_alloc +.It Fn mparse_free +.It Fn mparse_readfd +.It Fn mparse_reset +.It Fn mparse_result +.It Fn mparse_strerror +.It Fn mparse_strlevel +.El +.Ss Variables +.Bl -ohang +.It Va man_macronames +.It Va mdoc_argnames +.It Va mdoc_macronames +.El .Sh IMPLEMENTATION NOTES This section consists of structural documentation for .Xr mdoc 7 |