# HG changeset patch
# User Aziz K?ksal <aziz.koeksal@gmail.com>
# Date 1202918927 -3600
# Node ID 6efa938dbef771f8a1c8f3401c2d4150462089a1
# Parent  51e9dfe27f20b55d49d9459be0838c690b46dd3e
Added documentation comments.

diff -r 51e9dfe27f20 -r 6efa938dbef7 trunk/src/dil/doc/Macro.d
--- a/trunk/src/dil/doc/Macro.d	Wed Feb 13 15:45:32 2008 +0100
+++ b/trunk/src/dil/doc/Macro.d	Wed Feb 13 17:08:47 2008 +0100
@@ -11,6 +11,7 @@
 import dil.Messages;
 import common;
 
+/// The DDoc macro class.
 class Macro
 {
   string name; /// The name of the macro.
@@ -23,6 +24,10 @@
   }
 }
 
+/// Maps macro names to Macro objects.
+///
+/// MacroTables can be chained so that they build a linear hierarchy.
+/// Macro definitions in the current table override the ones in the parent tables.
 class MacroTable
 {
   MacroTable parent;
@@ -33,22 +38,27 @@
     this.parent = parent;
   }
 
-  void insert(Macro macro_)
+  /// Inserts the macro m into the table.
+  /// Overwrites the current macro if one exists.
+  void insert(Macro m)
   {
-    table[macro_.name] = macro_;
+    table[m.name] = m;
   }
 
+  /// Inserts an array of macros into the table.
   void insert(Macro[] macros)
   {
-    foreach (macro_; macros)
-      insert(macro_);
+    foreach (m; macros)
+      insert(m);
   }
 
+  /// Creates a macro using name and text and inserts that into the table.
   void insert(string name, string text)
   {
     insert(new Macro(name, text));
   }
 
+  /// Creates a macro using name[n] and text[n] and inserts that into the table.
   void insert(string[] names, string[] texts)
   {
     assert(names.length == texts.length);
@@ -56,16 +66,22 @@
       insert(name, texts[i]);
   }
 
+  /// Searches for a macro.
+  ///
+  /// If the macro isn't found in this table the search
+  /// continues upwards in the table hierarchy.
+  /// Returns: the macro if found, or null if not.
   Macro search(string name)
   {
     auto pmacro = name in table;
     if (pmacro)
       return *pmacro;
-    if (parent)
+    if (!isRoot())
       return parent.search(name);
     return null;
   }
 
+  /// Returns: true if this is the root of the hierarchy.
   bool isRoot()
   { return parent is null; }
 }