Documented ARGS_ handling in args().

[mandoc.git] / mdoc_argv.c

diff --git a/mdoc_argv.c b/mdoc_argv.c
index 1efed9c4f14f8d1d85a59c55bcaabcc220b4ab82..6e2c48b3cea630ed22ad0e83f3d1205e80d0c972 100644 (file)
--- a/mdoc_argv.c
+++ b/mdoc_argv.c
@@ -1,4 +1,4 @@
-/*     $Id: mdoc_argv.c,v 1.23 2009/08/20 08:59:12 kristaps Exp $ */
+/*     $Id: mdoc_argv.c,v 1.24 2009/08/20 09:07:24 kristaps Exp $ */
 /*
  * Copyright (c) 2008, 2009 Kristaps Dzonsons <kristaps@kth.se>
  *
@@ -375,6 +375,21 @@ args(struct mdoc *m, int line, int *pos,
        int               i;
        char             *p, *pp;
 
+       /*
+        * Parse out the terms (like `val' in `.Xx -arg val' or simply
+        * `.Xx val'), which can have all sorts of properties:
+        *
+        *   ARGS_DELIM: use special handling if encountering trailing
+        *   delimiters in the form of [[::delim::][ ]+]+.
+        *
+        *   ARGS_NOWARN: don't post warnings.  This is only used when
+        *   re-parsing delimiters, as the warnings have already been
+        *   posted.
+        *
+        *   ARGS_TABSEP: use special handling for tab/`Ta' separated
+        *   phrases like in `Bl -column'.
+        */
+
        assert(*pos);
        assert(' ' != buf[*pos]);