summaryrefslogtreecommitdiffstats
path: root/parse.c
diff options
context:
space:
mode:
authorTavian Barnes <tavianator@tavianator.com>2019-02-01 00:04:33 -0500
committerTavian Barnes <tavianator@tavianator.com>2019-02-09 17:06:38 -0500
commitd64db6bad79e10f92c56e5572d6ae9072d62b3a3 (patch)
treef1f334c165afecd1907e9c4cf377878ba172c35a /parse.c
parent563b5f9d48e54dc2f5d61a23ce2171e005da201a (diff)
downloadbfs-d64db6bad79e10f92c56e5572d6ae9072d62b3a3.tar.xz
Add some documentation comments
Diffstat (limited to 'parse.c')
-rw-r--r--parse.c7
1 files changed, 7 insertions, 0 deletions
diff --git a/parse.c b/parse.c
index 42a5a8f..80aeb88 100644
--- a/parse.c
+++ b/parse.c
@@ -14,6 +14,13 @@
* OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. *
****************************************************************************/
+/**
+ * The command line parser. Expressions are parsed by recursive descent, with a
+ * grammar described in the comments of the parse_*() functions. The parser
+ * also accepts flags and paths at any point in the expression, by treating
+ * flags like always-true options, and skipping over paths wherever they appear.
+ */
+
#include "bfs.h"
#include "cmdline.h"
#include "diag.h"