diff options
Diffstat (limited to 'mdoc.h')
| -rw-r--r-- | mdoc.h | 14 |
1 files changed, 10 insertions, 4 deletions
@@ -1,4 +1,4 @@ -/* $Id: mdoc.h,v 1.32 2009/02/22 22:58:39 kristaps Exp $ */ +/* $Id: mdoc.h,v 1.33 2009/02/23 09:33:34 kristaps Exp $ */ /* * Copyright (c) 2008 Kristaps Dzonsons <kristaps@kth.se> * @@ -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 |