Add manual page for mandoc-db (mostly to document the file format of

[mandoc.git] / libmandoc.h

diff --git a/libmandoc.h b/libmandoc.h
index d3cc643ec9ae176f9121e96ba28711b2ce933926..3157f290f25e78808c50c594acfda33e74441421 100644 (file)
--- a/libmandoc.h
+++ b/libmandoc.h
@@ -1,4 +1,4 @@
-/*     $Id: libmandoc.h,v 1.15 2011/03/22 10:02:50 kristaps Exp $ */
+/*     $Id: libmandoc.h,v 1.17 2011/03/28 23:52:13 kristaps Exp $ */
 /*
  * Copyright (c) 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>
  *
@@ -29,17 +29,15 @@ enum        rofferr {
        ROFF_ERR /* badness: puke and stop */
 };
 
-/*
- * Available registers (set in libroff, accessed elsewhere).
- */
 enum   regs {
-       REG_nS = 0,
+       REG_nS = 0, /* nS register */
        REG__MAX
 };
 
 /*
  * A register (struct reg) can consist of many types: this consists of
- * normalised types from the original string form.
+ * normalised types from the original string form.  For the time being,
+ * there's only an unsigned integer type.
  */
 union  regval {
        unsigned  u; /* unsigned integer */
@@ -76,11 +74,12 @@ void                 mandoc_msg(enum mandocerr, struct mparse *,
 void            mandoc_vmsg(enum mandocerr, struct mparse *, 
                        int, int, const char *, ...);
 int             mandoc_special(char *);
-char            *mandoc_strdup(const char *);
-char            *mandoc_getarg(struct mparse *, char **, int, int *);
-char            *mandoc_normdate(struct mparse *, char *, int, int);
+char           *mandoc_strdup(const char *);
+char           *mandoc_getarg(struct mparse *, char **, int, int *);
+char           *mandoc_normdate(struct mparse *, char *, int, int);
 int             mandoc_eos(const char *, size_t, int);
 int             mandoc_hyph(const char *, const char *);
+int             mandoc_getcontrol(const char *, int *);
 
 void            mdoc_free(struct mdoc *);
 struct mdoc    *mdoc_alloc(struct regset *, struct mparse *);
@@ -103,11 +102,10 @@ struct roff       *roff_alloc(struct regset *, struct mparse *);
 void            roff_reset(struct roff *);
 enum rofferr    roff_parseln(struct roff *, int, 
                        char **, size_t *, int, int *);
-void             roff_endparse(struct roff *);
-
-const struct tbl_span *roff_span(const struct roff *);
-const struct eqn *roff_eqn(const struct roff *);
+void            roff_endparse(struct roff *);
 
+const struct tbl_span  *roff_span(const struct roff *);
+const struct eqn       *roff_eqn(const struct roff *);
 
 __END_DECLS