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 | 8c7b007b48c1d2f7ca24bcd97b3cca40f4ffa115 (patch) | |
| tree | ba6fefa9d31b7c36849cf07f196ae6b68443d45d /mandoc.3 | |
| parent | 629374d4ffde37c9a77c85f9a2e2e819c0efd53e (diff) | |
| download | mandoc-8c7b007b48c1d2f7ca24bcd97b3cca40f4ffa115.tar.gz mandoc-8c7b007b48c1d2f7ca24bcd97b3cca40f4ffa115.tar.zst mandoc-8c7b007b48c1d2f7ca24bcd97b3cca40f4ffa115.zip | |
Skeleton of documentation functions, types, and variables in mandoc.h.
Diffstat (limited to 'mandoc.3')
| -rw-r--r-- | mandoc.3 | 45 |
1 files changed, 43 insertions, 2 deletions
@@ -1,4 +1,4 @@ -.\" $Id: mandoc.3,v 1.2 2011/03/28 21:49:42 kristaps Exp $ +.\" $Id: mandoc.3,v 1.3 2011/04/09 15:53:48 kristaps Exp $ .\" .\" Copyright (c) 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv> .\" Copyright (c) 2010 Ingo Schwarze <schwarze@openbsd.org> @@ -15,11 +15,12 @@ .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. .\" -.Dd $Mdocdate: March 28 2011 $ +.Dd $Mdocdate: April 9 2011 $ .Dt MANDOC 3 .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 |