Adding mdoclint.1 manual.

[mandoc.git] / mdoc.h

diff --git a/mdoc.h b/mdoc.h
index dec60b2fe4ccf6a9f081088583e42f39ead3f324..fdd5585d00eda4460aa1e15c3a7a4e7b76a74ac3 100644 (file)
--- a/mdoc.h
+++ b/mdoc.h
@@ -1,4 +1,4 @@
-/* $Id: mdoc.h,v 1.31 2009/02/22 14:31:08 kristaps Exp $ */
+/* $Id: mdoc.h,v 1.33 2009/02/23 09:33:34 kristaps Exp $ */

 /*
  * Copyright (c) 2008 Kristaps Dzonsons <kristaps@kth.se>
  *
 /*
  * Copyright (c) 2008 Kristaps Dzonsons <kristaps@kth.se>
  *


@@ -19,6 +19,14 @@
 #ifndef MDOC_H
 #define MDOC_H
 
 #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
 /* What follows is a list of ALL possible macros. */
 
 #define        MDOC___          0


@@ -413,20 +421,18 @@ struct    mdoc     *mdoc_alloc(void *data, const struct mdoc_cb *);
 int              mdoc_parseln(struct mdoc *, int, char *buf);
 
 /* Get result first node (after mdoc_endparse!). */
 int              mdoc_parseln(struct mdoc *, int, char *buf);
 
 /* Get result first node (after mdoc_endparse!). */

-const struct mdoc_node *mdoc_node(struct mdoc *);
+const struct mdoc_node *mdoc_node(const struct mdoc *);

 
 /* Get result meta-information (after mdoc_endparse!). */
 
 /* Get result meta-information (after mdoc_endparse!). */

-const struct mdoc_meta *mdoc_meta(struct mdoc *);
+const struct mdoc_meta *mdoc_meta(const struct mdoc *);

 
 /* Signal end of parse sequence (boolean retval). */
 int              mdoc_endparse(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_arch2a(enum mdoc_arch);

-

 const char      *mdoc_vol2a(enum mdoc_vol);
 const char      *mdoc_vol2a(enum mdoc_vol);

-

 const char      *mdoc_msec2a(enum mdoc_msec);
 const char      *mdoc_msec2a(enum mdoc_msec);

-

 int              mdoc_isdelim(const char *);
 
 __END_DECLS
 int              mdoc_isdelim(const char *);
 
 __END_DECLS