diff options
| author |   Kristaps Dzonsons <kristaps@bsd.lv> | 2011-03-22 13:28:22 +0000 |
|---|---|---|
| committer | Kristaps Dzonsons <kristaps@bsd.lv> | 2011-03-22 13:28:22 +0000 |
| commit | bce51df74cd9c0cb090845736c5e6f8313d4fd6c (patch) | |
| tree | 008ffce3b36b92fcbdb107fdd4a5578741709c4b /man.h | |
| parent | 5d28cf2c95926688a339a7460cc132b4e3fb3476 (diff) | |
| download | mandoc-bce51df74cd9c0cb090845736c5e6f8313d4fd6c.tar.gz mandoc-bce51df74cd9c0cb090845736c5e6f8313d4fd6c.tar.zst mandoc-bce51df74cd9c0cb090845736c5e6f8313d4fd6c.zip | |
Add some documentation and clean up mdoc.h/man.h.
Diffstat (limited to 'man.h')
| -rw-r--r-- | man.h | 19 |
1 files changed, 2 insertions, 17 deletions
@@ -1,4 +1,4 @@ -/* $Id: man.h,v 1.56 2011/03/22 09:48:13 kristaps Exp $ */ +/* $Id: man.h,v 1.57 2011/03/22 13:28:22 kristaps Exp $ */ /* * Copyright (c) 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv> * @@ -17,9 +17,6 @@ #ifndef MAN_H #define MAN_H -/* - * What follows is a list of ALL possible macros. - */ enum mant { MAN_br = 0, MAN_TH, @@ -57,9 +54,6 @@ enum mant { MAN_MAX }; -/* - * Type of a syntax node. - */ enum man_type { MAN_TEXT, MAN_ELEM, @@ -71,9 +65,6 @@ enum man_type { MAN_EQN }; -/* - * Information from prologue. - */ struct man_meta { char *msec; /* `TH' section (1, 3p, etc.) */ char *date; /* `TH' normalised date */ @@ -82,9 +73,6 @@ struct man_meta { char *source; /* `TH' source (e.g., GNU) */ }; -/* - * Single node in tree-linked AST. - */ struct man_node { struct man_node *parent; /* parent AST node */ struct man_node *child; /* first child AST node */ @@ -106,10 +94,7 @@ struct man_node { const struct eqn *eqn; /* EQN */ }; -/* - * Names of macros. Index is enum mant. Indexing into this returns - * the normalised name, e.g., man_macronames[MAN_SH] -> "SH". - */ +/* Names of macros. Index is enum mant. */ extern const char *const *man_macronames; __BEGIN_DECLS |