Add some Doxygen @brief lines.

anse1 · Jun 2, 2016 · 279980b · 279980b
1 parent ac945c3
commit 279980b
Show file tree

Hide file tree

Showing 9 changed files with 32 additions and 2 deletions.
diff --git a/dump.hh b/dump.hh
@@ -1,3 +1,5 @@
+/// @file
+/// @brief Dump syntax trees as GraphML
 #ifndef DUMP_HH
 #define DUMP_HH
 

diff --git a/expr.hh b/expr.hh
@@ -1,3 +1,6 @@
+/// @file
+/// @brief grammar: Value expression productions
+
 #ifndef EXPR_HH
 #define EXPR_HH
 

diff --git a/grammar.hh b/grammar.hh
@@ -1,3 +1,6 @@
+/// @file
+/// @brief grammar: Top-level and unsorted grammar productions
+
 #ifndef GRAMMAR_HH
 #define GRAMMAR_HH
 

diff --git a/impedance.hh b/impedance.hh
@@ -1,5 +1,6 @@
-/* Provide feedback to the grammar about failed queries to weed out
-   unsupported productions. */
+/// @file
+/// @brief feedback to the grammar about failed productions
+
 
 #ifndef IMPEDANCE_HH
 #define IMPEDANCE_HH

diff --git a/log.hh b/log.hh
@@ -1,3 +1,6 @@
+/// @file
+/// @brief logging
+
 #ifndef LOG_HH
 #define LOG_HH
 
@@ -7,12 +10,14 @@
 
 #include "prod.hh"
 
+/// logger base class
 struct logger {
   virtual void generated(prod &query) { }
   virtual void executed(prod &query) { }
   virtual void error(prod &query, const pqxx::failure &e) { }
 };
 
+/// logger for statistics collection
 struct stats_collecting_logger : logger {
   long queries = 0;
   float sum_nodes = 0;
@@ -21,6 +26,7 @@ struct stats_collecting_logger : logger {
   virtual void generated(prod &query);
 };
 
+/// stderr logger
 struct cerr_logger : stats_collecting_logger {
   const int columns = 80;
   std::map<std::string, long> errors;
@@ -31,6 +37,7 @@ struct cerr_logger : stats_collecting_logger {
   void report(prod &p);
 };
 
+/// logger to postgres database
 struct pqxx_logger : stats_collecting_logger {
   long id;
   std::shared_ptr<pqxx::connection> c;

diff --git a/prod.hh b/prod.hh
@@ -1,14 +1,19 @@
+/// @file
+/// @brief Base class for grammar productions
+
 #include <string>
 #include <iostream>
 
 #ifndef PROD_HH
 #define PROD_HH
 
+/// Base class for walking the AST
 struct prod_visitor {
   virtual void visit(struct prod *p) = 0;
   virtual ~prod_visitor() { }
 };
 
+/// Base class for AST nodes
 struct prod {
   struct prod *pprod;
   struct scope *scope;

diff --git a/random.hh b/random.hh
@@ -1,3 +1,6 @@
+/// @file
+/// @brief randomness
+
 #ifndef RANDOM_HH
 #define RANDOM_HH
 

diff --git a/relmodel.hh b/relmodel.hh
@@ -1,3 +1,6 @@
+/// @file
+/// @brief supporting classes for the grammar
+
 #ifndef RELMODEL_HH
 #define RELMODEL_HH
 #include <string>

diff --git a/schema.hh b/schema.hh
@@ -1,3 +1,6 @@
+/// @file
+/// @brief schema information for grammar
+
 #ifndef SCHEMA_HH
 #define SCHEMA_HH