From: kristaps@mdocml.bsd.lv
To: source@mdocml.bsd.lv
Subject: mdocml: Skeleton of documentation functions, types, and variables in
Date: Sat, 9 Apr 2011 11:53:48 -0400 (EDT) [thread overview]
Message-ID: <201104091553.p39FrmOl005576@krisdoz.my.domain> (raw)
Log Message:
-----------
Skeleton of documentation functions, types, and variables in mandoc.h.
Modified Files:
--------------
mdocml:
mandoc.3
Revision Data
-------------
Index: mandoc.3
===================================================================
RCS file: /usr/vhosts/mdocml.bsd.lv/cvs/mdocml/mandoc.3,v
retrieving revision 1.2
retrieving revision 1.3
diff -Lmandoc.3 -Lmandoc.3 -u -p -r1.2 -r1.3
--- mandoc.3
+++ mandoc.3
@@ -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"
@@ -130,6 +137,40 @@ free all allocated memory with
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
--
To unsubscribe send an email to source+unsubscribe@mdocml.bsd.lv
reply other threads:[~2011-04-09 15:53 UTC|newest]
Thread overview: [no followups] expand[flat|nested] mbox.gz Atom feed
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=201104091553.p39FrmOl005576@krisdoz.my.domain \
--to=kristaps@mdocml.bsd.lv \
--cc=source@mdocml.bsd.lv \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).