diff trunk/src/dil/doc/Macro.d @ 769:5e3ef1b2011c

Added and improved documentation.
author Aziz K?ksal <aziz.koeksal@gmail.com>
date Sun, 17 Feb 2008 02:21:55 +0100
parents 6efa938dbef7
children 3b34f6a95a27
line wrap: on
line diff
--- a/trunk/src/dil/doc/Macro.d	Sat Feb 16 22:10:21 2008 +0100
+++ b/trunk/src/dil/doc/Macro.d	Sun Feb 17 02:21:55 2008 +0100
@@ -15,7 +15,7 @@
 class Macro
 {
   string name; /// The name of the macro.
-  string text; /// Substitution text.
+  string text; /// The substitution text.
   uint callLevel;  /// Recursive call level.
   this (string name, string text)
   {
@@ -99,7 +99,7 @@
     return macros;
   }
 
-  /// Scans for a macro invocation. E.g.: $&#40;DDOC&#41;
+  /// Scans for a macro invocation. E.g.: &#36;(DDOC)
   /// Returns: a pointer set to one char past the closing parenthesis,
   /// or null if this isn't a macro invocation.
   static char* scanMacro(char* p, char* textEnd)
@@ -296,11 +296,11 @@
     return arg0 ~ args;
   }
 
-  /// Expands "$ +", "$ 0" - "$ 9" with args[n] in text.
+  /// Expands "&#36;+", "&#36;0" - "&#36;9" with args[n] in text.
   /// Params:
   ///   text = the text to scan for argument placeholders.
   ///   args = the first element, args[0], is the whole argument string and
-  ///          the following elements are slices into it.
+  ///          the following elements are slices into it.$(BR)
   ///          The array is empty if there are no arguments.
   char[] expandArguments(char[] text, char[][] args)
   in { assert(args.length != 1, "zero or more than 1 args expected"); }