Build compiler documentation.

git-svn-id: http://svn.drobilla.net/resp/tuplr@163 ad02d1e2-f140-0410-9f75-f8b11f17cedd

9 files changed, 36 insertions, 12 deletions

diff --git a/src/typing.cpp b/src/constrain.cpp
index 787f445..a1868c4 100644
--- a/src/typing.cpp
+++ b/src/constrain.cpp
@@ -15,13 +15,13 @@
  * along with Tuplr.  If not, see <http://www.gnu.org/licenses/>.
  */
 
+/** @file
+ * @brief Constrain type of AST expressions
+ */
+
 #include <set>
 #include "tuplr.hpp"
 
-/***************************************************************************
- * AST Type Constraints                                                    *
- ***************************************************************************/
-
 void
 ASymbol::constrain(TEnv& tenv, Constraints& c) const
 {
diff --git a/src/cps.cpp b/src/cps.cpp
index 8df11c2..19c95cc 100644
--- a/src/cps.cpp
+++ b/src/cps.cpp
@@ -15,13 +15,13 @@
  * along with Tuplr.  If not, see <http://www.gnu.org/licenses/>.
  */
 
+/** @file
+ * @brief Convert AST to Continuation Passing Style
+ */
+
 #include <set>
 #include "tuplr.hpp"
 
-/***************************************************************************
- * CPS Conversion                                                          *
- ***************************************************************************/
-
 /** (cps x cont) => (cont x) */
 AST*
 AST::cps(TEnv& tenv, AST* cont)
diff --git a/src/gc.cpp b/src/gc.cpp
index 3964324..9e964b4 100644
--- a/src/gc.cpp
+++ b/src/gc.cpp
@@ -15,6 +15,10 @@
  * along with Tuplr.  If not, see <http://www.gnu.org/licenses/>.
  */
 
+/** @file
+ * @brief Garbage collection
+ */
+
 #include <cassert>
 #include <set>
 #include <iostream>
diff --git a/src/gclib.cpp b/src/gclib.cpp
index 8c9f140..121e10c 100644
--- a/src/gclib.cpp
+++ b/src/gclib.cpp
@@ -15,6 +15,10 @@
  * along with Tuplr.  If not, see <http://www.gnu.org/licenses/>.
  */
 
+/** @file
+ * @brief Garbage collection shared library interface
+ */
+
 #include "tuplr.hpp"
 #include <stdio.h>
 #include <stdlib.h>
diff --git a/src/llvm.cpp b/src/llvm.cpp
index b5e397e..b89973d 100644
--- a/src/llvm.cpp
+++ b/src/llvm.cpp
@@ -15,6 +15,10 @@
  * along with Tuplr.  If not, see <http://www.gnu.org/licenses/>.
  */
 
+/** @file
+ * @brief Compile AST to LLVM IR
+ */
+
 #include <map>
 #include <sstream>
 #include <boost/format.hpp>
diff --git a/src/pprint.cpp b/src/pprint.cpp
index 04e3401..f156462 100644
--- a/src/pprint.cpp
+++ b/src/pprint.cpp
@@ -15,6 +15,10 @@
  * along with Tuplr.  If not, see <http://www.gnu.org/licenses/>.
  */
 
+/** @file
+ * @brief Pretty-print AST expressions
+ */
+
 #include "tuplr.hpp"
 
 ostream&
diff --git a/src/tuplr.cpp b/src/tuplr.cpp
index 7dd3e9b..7ff9f52 100644
--- a/src/tuplr.cpp
+++ b/src/tuplr.cpp
@@ -15,6 +15,10 @@
  * along with Tuplr.  If not, see <http://www.gnu.org/licenses/>.
  */
 
+/** @file
+ * @brief Main program
+ */
+
 #include <cerrno>
 #include <cstring>
 #include <fstream>
diff --git a/src/tuplr.hpp b/src/tuplr.hpp
index 5275dfd..613be0d 100644
--- a/src/tuplr.hpp
+++ b/src/tuplr.hpp
@@ -15,6 +15,10 @@
  * along with Tuplr.  If not, see <http://www.gnu.org/licenses/>.
  */
 
+/** @file
+ * @brief Interface and type definitions
+ */
+
 #ifndef TUPLR_HPP
 #define TUPLR_HPP
 
diff --git a/src/unify.cpp b/src/unify.cpp
index 91d6fde..0383df0 100644
--- a/src/unify.cpp
+++ b/src/unify.cpp
@@ -15,13 +15,13 @@
  * along with Tuplr.  If not, see <http://www.gnu.org/licenses/>.
  */
 
+/** @file
+ * @brief Unify type constraints
+ */
+
 #include <set>
 #include "tuplr.hpp"
 
-/***************************************************************************
- * Type Inference/Substitution                                             *
- ***************************************************************************/
-
 void
 Constraints::constrain(TEnv& tenv, const AST* o, AType* t)
 {