X-Git-Url: https://git.cameronkatri.com/mandoc.git/blobdiff_plain/8c0bc76f597bfa8102ebaae346815b1375f941f4..6a4217540b7dab72e441d0fb427eed052d3d0581:/mdoc.h?ds=sidebyside

diff --git a/mdoc.h b/mdoc.h
index dec60b2f..fdd5585d 100644
--- 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>
  *
@@ -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
@@ -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!). */
-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