From 63308441ecf8e6e192479a8ca6ef386805aa36b0 Mon Sep 17 00:00:00 2001
From: Paul Beckingham <paul@beckingham.net>
Date: Sat, 9 Jul 2011 18:08:54 -0400
Subject: [PATCH] Documentation

- Added internal documentation on the use of categorized arguments
  in filters.
---
 src/Arguments.cpp | 31 ++++++++++++++++++++++++++++++-
 1 file changed, 30 insertions(+), 1 deletion(-)

diff --git a/src/Arguments.cpp b/src/Arguments.cpp
index 898aae9d6..d8ce9acb4 100644
--- a/src/Arguments.cpp
+++ b/src/Arguments.cpp
@@ -248,7 +248,36 @@ void Arguments::append_stdin ()
 }
 
 ////////////////////////////////////////////////////////////////////////////////
-// Scan all the arguments, and assign a category for each one.
+// Scan all the arguments, and assign a category for each one.  The categories
+// are used to identify arguments types, and when extracting filters and
+// modifications.
+//
+// Categories and filters:
+//
+//               ro    wr    mods  words
+// terminator     -     -     -     -
+// program        -     -     -     -
+// command        -     -     -     -
+// rc             -     -     -     -
+// override       -     -     -     -
+// id             Y     Y     Err   Y
+// uuid           Y     Y     Err   Y
+// word           Y     <     >     Y
+// tag            Y     <     >     Y
+// attmod         Y     <     Err   -
+// attr           Y     <     >     -
+// substitution   Err   Err   >     Y
+// pattern        Y     <     Err   Y
+// op             Y     <     >     Y
+// exp            Y     <     Err   Y
+// 
+// Legend:
+//   Y    Included
+//   -    Excluded
+//   <    Included if before <command>
+//   >    Included if after <command>
+//   Err  Error if present
+
 void Arguments::categorize ()
 {
   bool terminated                     = false;