summaryrefslogtreecommitdiffstats
path: root/mdoc.h
diff options
context:
space:
mode:
authorKristaps Dzonsons <kristaps@bsd.lv>2009-02-23 09:33:34 +0000
committerKristaps Dzonsons <kristaps@bsd.lv>2009-02-23 09:33:34 +0000
commite6d5d6c4fa9992652ddd38c1f1a1bd0c10a275a2 (patch)
treed8b9fd946d7e6a443abba618088edc43f5936b3e /mdoc.h
parent63967ed8bf5ca40c3477ce83deda9051e813afd4 (diff)
downloadmandoc-e6d5d6c4fa9992652ddd38c1f1a1bd0c10a275a2.tar.gz
Considerable mdoc.3 documentation.
Added a few more escapes and macros.
Diffstat (limited to 'mdoc.h')
-rw-r--r--mdoc.h12
1 files changed, 9 insertions, 3 deletions
diff --git a/mdoc.h b/mdoc.h
index 544950f5..35c5a598 100644
--- a/mdoc.h
+++ b/mdoc.h
@@ -19,6 +19,14 @@
#ifndef MDOC_H
#define MDOC_H
+/*
+ * This library implements a validating scanner/parser for ``mdoc'' roff
+ * macro documents, a.k.a. BSD manual page documents. The mdoc.c file
+ * drives the parser, while macro.c describes the macro ontologies.
+ * validate.c pre- and post-validates parsed macros, and action.c
+ * performs actions on parsed and validated macros.
+ */
+
/* What follows is a list of ALL possible macros. */
#define MDOC___ 0
@@ -421,12 +429,10 @@ const struct mdoc_meta *mdoc_meta(const struct mdoc *);
/* Signal end of parse sequence (boolean retval). */
int mdoc_endparse(struct mdoc *);
+/* The following are utility functions. */
const char *mdoc_arch2a(enum mdoc_arch);
-
const char *mdoc_vol2a(enum mdoc_vol);
-
const char *mdoc_msec2a(enum mdoc_msec);
-
int mdoc_isdelim(const char *);
__END_DECLS