===================================================================
RCS file: /cvs/mandoc/mdoc.h,v
retrieving revision 1.31
retrieving revision 1.34
diff -u -p -r1.31 -r1.34
--- mandoc/mdoc.h	2009/02/22 14:31:08	1.31
+++ mandoc/mdoc.h	2009/02/24 12:20:52	1.34
@@ -1,4 +1,4 @@
-/* $Id: mdoc.h,v 1.31 2009/02/22 14:31:08 kristaps Exp $ */
+/* $Id: mdoc.h,v 1.34 2009/02/24 12:20:52 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
@@ -355,8 +363,6 @@ struct	mdoc_block {
 
 /* In-line element node. */
 struct	mdoc_elem {
-	size_t		  sz;
-	char		**args;
 	size_t		  argc;
 	struct mdoc_arg	 *argv;
 };
@@ -413,20 +419,18 @@ struct	mdoc	 *mdoc_alloc(void *data, const struct mdoc
 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!). */
-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 *);
 
+/* 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