Merge pull request #889 from Geod24/update-ddoc-doc

Get documentation of the documentation generator in sync with the compiler

ddoc.dd

@@ -496,7 +496,7 @@ $(P
 
 $(P
     Text inside these sections will be escaped according to the rules described above,
-    then wrapped in a $(D $(RAW_DOLLAR)(DDOC_BACKQUOTED)) macro. By default, this macro expands
+    then wrapped in a $(D $(DOLLAR)(DDOC_BACKQUOTED)) macro. By default, this macro expands
     to be displayed as an inline text span, formatted as code.
 )
 
@@ -684,101 +684,117 @@ $(P
 )
 
 $(DDOCCODE
-B =     $(LT)b$(GT)$(RAW_DOLLAR)0$(LT)/b$(GT)
-I =     $(LT)i$(GT)$(RAW_DOLLAR)0$(LT)/i$(GT)
-U =     $(LT)u$(GT)$(RAW_DOLLAR)0$(LT)/u$(GT)
-P =     $(LT)p$(GT)$(RAW_DOLLAR)0$(LT)/p$(GT)
-DL =    $(LT)dl$(GT)$(RAW_DOLLAR)0$(LT)/dl$(GT)
-DT =    $(LT)dt$(GT)$(RAW_DOLLAR)0$(LT)/dt$(GT)
-DD =    $(LT)dd$(GT)$(RAW_DOLLAR)0$(LT)/dd$(GT)
-TABLE = $(LT)table$(GT)$(RAW_DOLLAR)0$(LT)/table$(GT)
-TR =    $(LT)tr$(GT)$(RAW_DOLLAR)0$(LT)/tr$(GT)
-TH =    $(LT)th$(GT)$(RAW_DOLLAR)0$(LT)/th$(GT)
-TD =    $(LT)td$(GT)$(RAW_DOLLAR)0$(LT)/td$(GT)
-OL =    $(LT)ol$(GT)$(RAW_DOLLAR)0$(LT)/ol$(GT)
-UL =    $(LT)ul$(GT)$(RAW_DOLLAR)0$(LT)/ul$(GT)
-LI =    $(LT)li$(GT)$(RAW_DOLLAR)0$(LT)/li$(GT)
-BIG =   $(LT)big$(GT)$(RAW_DOLLAR)0$(LT)/big$(GT)
-SMALL = $(LT)small$(GT)$(RAW_DOLLAR)0$(LT)/small$(GT)
+B =     $(LT)b$(GT)$(DOLLAR)0$(LT)/b$(GT)
+I =     $(LT)i$(GT)$(DOLLAR)0$(LT)/i$(GT)
+U =     $(LT)u$(GT)$(DOLLAR)0$(LT)/u$(GT)
+P =     $(LT)p$(GT)$(DOLLAR)0$(LT)/p$(GT)
+DL =    $(LT)dl$(GT)$(DOLLAR)0$(LT)/dl$(GT)
+DT =    $(LT)dt$(GT)$(DOLLAR)0$(LT)/dt$(GT)
+DD =    $(LT)dd$(GT)$(DOLLAR)0$(LT)/dd$(GT)
+TABLE = $(LT)table$(GT)$(DOLLAR)0$(LT)/table$(GT)
+TR =    $(LT)tr$(GT)$(DOLLAR)0$(LT)/tr$(GT)
+TH =    $(LT)th$(GT)$(DOLLAR)0$(LT)/th$(GT)
+TD =    $(LT)td$(GT)$(DOLLAR)0$(LT)/td$(GT)
+OL =    $(LT)ol$(GT)$(DOLLAR)0$(LT)/ol$(GT)
+UL =    $(LT)ul$(GT)$(DOLLAR)0$(LT)/ul$(GT)
+LI =    $(LT)li$(GT)$(DOLLAR)0$(LT)/li$(GT)
+BIG =   $(LT)big$(GT)$(DOLLAR)0$(LT)/big$(GT)
+SMALL = $(LT)small$(GT)$(DOLLAR)0$(LT)/small$(GT)
 BR =    $(LT)br$(GT)
-LINK =  $(LT)a href="$(RAW_DOLLAR)0"$(GT)$(RAW_DOLLAR)0$(LT)/a$(GT)
-LINK2 = $(LT)a href="$(RAW_DOLLAR)1"$(GT)$(RAW_DOLLAR)+$(LT)/a$(GT)
+LINK =  $(LT)a href="$(DOLLAR)0"$(GT)$(DOLLAR)0$(LT)/a$(GT)
+LINK2 = $(LT)a href="$(DOLLAR)1"$(GT)$(DOLLAR)+$(LT)/a$(GT)
 LPAREN= $(LPAREN)
 RPAREN= $(RPAREN)
-
-RED =   $(LT)font color=red$(GT)$(RAW_DOLLAR)0$(LT)/font$(GT)
-BLUE =  $(LT)font color=blue$(GT)$(RAW_DOLLAR)0$(LT)/font$(GT)
-GREEN = $(LT)font color=green$(GT)$(RAW_DOLLAR)0$(LT)/font$(GT)
-YELLOW =$(LT)font color=yellow$(GT)$(RAW_DOLLAR)0$(LT)/font$(GT)
-BLACK = $(LT)font color=black$(GT)$(RAW_DOLLAR)0$(LT)/font$(GT)
-WHITE = $(LT)font color=white$(GT)$(RAW_DOLLAR)0$(LT)/font$(GT)
-
-D_CODE = $(LT)pre class="d_code"$(GT)$(RAW_DOLLAR)0$(LT)/pre$(GT)
-D_COMMENT = $(RAW_DOLLAR)(GREEN $(RAW_DOLLAR)0)
-D_STRING  = $(RAW_DOLLAR)(RED $(RAW_DOLLAR)0)
-D_KEYWORD = $(RAW_DOLLAR)(BLUE $(RAW_DOLLAR)0)
-D_PSYMBOL = $(RAW_DOLLAR)(U $(RAW_DOLLAR)0)
-D_PARAM   = $(RAW_DOLLAR)(I $(RAW_DOLLAR)0)
+DOLLAR= $(DOLLAR)
+DEPRECATED=$(DOLLAR)0
+
+RED =   $(LT)font color=red$(GT)$(DOLLAR)0$(LT)/font$(GT)
+BLUE =  $(LT)font color=blue$(GT)$(DOLLAR)0$(LT)/font$(GT)
+GREEN = $(LT)font color=green$(GT)$(DOLLAR)0$(LT)/font$(GT)
+YELLOW =$(LT)font color=yellow$(GT)$(DOLLAR)0$(LT)/font$(GT)
+BLACK = $(LT)font color=black$(GT)$(DOLLAR)0$(LT)/font$(GT)
+WHITE = $(LT)font color=white$(GT)$(DOLLAR)0$(LT)/font$(GT)
+
+D_CODE =    $(LT)pre class="d_code"$(GT)$(DOLLAR)0$(LT)/pre$(GT)
+D_COMMENT = $(DOLLAR)(GREEN $(DOLLAR)0)
+D_STRING  = $(DOLLAR)(RED $(DOLLAR)0)
+D_KEYWORD = $(DOLLAR)(BLUE $(DOLLAR)0)
+D_PSYMBOL = $(DOLLAR)(U $(DOLLAR)0)
+D_PARAM   = $(DOLLAR)(I $(DOLLAR)0)
 
 DDOC = $(LT)html$(GT)$(LT)head$(GT)
        $(LT)META http-equiv="content-type" content="text/html; charset=utf-8"$(GT)
-       $(LT)title$(GT)$(RAW_DOLLAR)(TITLE)$(LT)/title$(GT)
+       $(LT)title$(GT)$(DOLLAR)(TITLE)$(LT)/title$(GT)
        $(LT)/head$(GT)$(LT)body$(GT)
-       $(LT)h1$(GT)$(RAW_DOLLAR)(TITLE)$(LT)/h1$(GT)
-       $(RAW_DOLLAR)(BODY)
+       $(LT)h1$(GT)$(DOLLAR)(TITLE)$(LT)/h1$(GT)
+       $(DOLLAR)(BODY)
+       $(LT)hr$(GT)$(DOLLAR)(SMALL Page generated by $(DOLLAR)(LINK2 http://dlang.org/ddoc.html, Ddoc). $(DOLLAR)(COPYRIGHT))
        $(LT)/body$(GT)$(LT)/html$(GT)
 
-DDOC_COMMENT   = $(LT)!-- $(RAW_DOLLAR)0 --$(GT)
-DDOC_DECL      = $(RAW_DOLLAR)(DT $(RAW_DOLLAR)(BIG $(RAW_DOLLAR)0))
-DDOC_DECL_DD   = $(RAW_DOLLAR)(DD $(RAW_DOLLAR)0)
-DDOC_DITTO     = $(RAW_DOLLAR)(BR)$(RAW_DOLLAR)0
-DDOC_SECTIONS  = $(RAW_DOLLAR)0
-DDOC_SUMMARY   = $(RAW_DOLLAR)0$(RAW_DOLLAR)(BR)$(RAW_DOLLAR)(BR)
-DDOC_DESCRIPTION = $(RAW_DOLLAR)0$(RAW_DOLLAR)(BR)$(RAW_DOLLAR)(BR)
-DDOC_AUTHORS   = $(RAW_DOLLAR)(B Authors:)$(RAW_DOLLAR)(BR)
-        $(RAW_DOLLAR)0$(RAW_DOLLAR)(BR)$(RAW_DOLLAR)(BR)
-DDOC_BUGS      = $(RAW_DOLLAR)(RED BUGS:)$(RAW_DOLLAR)(BR)
-        $(RAW_DOLLAR)0$(RAW_DOLLAR)(BR)$(RAW_DOLLAR)(BR)
-DDOC_COPYRIGHT = $(RAW_DOLLAR)(B Copyright:)$(RAW_DOLLAR)(BR)
-        $(RAW_DOLLAR)0$(RAW_DOLLAR)(BR)$(RAW_DOLLAR)(BR)
-DDOC_DATE      = $(RAW_DOLLAR)(B Date:)$(RAW_DOLLAR)(BR)
-        $(RAW_DOLLAR)0$(RAW_DOLLAR)(BR)$(RAW_DOLLAR)(BR)
-DDOC_DEPRECATED = $(RAW_DOLLAR)(RED Deprecated:)$(RAW_DOLLAR)(BR)
-        $(RAW_DOLLAR)0$(RAW_DOLLAR)(BR)$(RAW_DOLLAR)(BR)
-DDOC_EXAMPLES  = $(RAW_DOLLAR)(B Examples:)$(RAW_DOLLAR)(BR)
-        $(RAW_DOLLAR)0$(RAW_DOLLAR)(BR)$(RAW_DOLLAR)(BR)
-DDOC_HISTORY   = $(RAW_DOLLAR)(B History:)$(RAW_DOLLAR)(BR)
-        $(RAW_DOLLAR)0$(RAW_DOLLAR)(BR)$(RAW_DOLLAR)(BR)
-DDOC_LICENSE   = $(RAW_DOLLAR)(B License:)$(RAW_DOLLAR)(BR)
-        $(RAW_DOLLAR)0$(RAW_DOLLAR)(BR)$(RAW_DOLLAR)(BR)
-DDOC_RETURNS   = $(RAW_DOLLAR)(B Returns:)$(RAW_DOLLAR)(BR)
-        $(RAW_DOLLAR)0$(RAW_DOLLAR)(BR)$(RAW_DOLLAR)(BR)
-DDOC_SEE_ALSO  = $(RAW_DOLLAR)(B See Also:)$(RAW_DOLLAR)(BR)
-        $(RAW_DOLLAR)0$(RAW_DOLLAR)(BR)$(RAW_DOLLAR)(BR)
-DDOC_STANDARDS = $(RAW_DOLLAR)(B Standards:)$(RAW_DOLLAR)(BR)
-        $(RAW_DOLLAR)0$(RAW_DOLLAR)(BR)$(RAW_DOLLAR)(BR)
-DDOC_THROWS    = $(RAW_DOLLAR)(B Throws:)$(RAW_DOLLAR)(BR)
-        $(RAW_DOLLAR)0$(RAW_DOLLAR)(BR)$(RAW_DOLLAR)(BR)
-DDOC_VERSION   = $(RAW_DOLLAR)(B Version:)$(RAW_DOLLAR)(BR)
-        $(RAW_DOLLAR)0$(RAW_DOLLAR)(BR)$(RAW_DOLLAR)(BR)
-DDOC_SECTION_H = $(RAW_DOLLAR)(B $(RAW_DOLLAR)0)$(RAW_DOLLAR)(BR)$(RAW_DOLLAR)(BR)
-DDOC_SECTION   = $(RAW_DOLLAR)0$(RAW_DOLLAR)(BR)$(RAW_DOLLAR)(BR)
-DDOC_MEMBERS   = $(RAW_DOLLAR)(DL $(RAW_DOLLAR)0)
-DDOC_MODULE_MEMBERS   = $(RAW_DOLLAR)(DDOC_MEMBERS $(RAW_DOLLAR)0)
-DDOC_CLASS_MEMBERS    = $(RAW_DOLLAR)(DDOC_MEMBERS $(RAW_DOLLAR)0)
-DDOC_STRUCT_MEMBERS   = $(RAW_DOLLAR)(DDOC_MEMBERS $(RAW_DOLLAR)0)
-DDOC_ENUM_MEMBERS     = $(RAW_DOLLAR)(DDOC_MEMBERS $(RAW_DOLLAR)0)
-DDOC_TEMPLATE_MEMBERS = $(RAW_DOLLAR)(DDOC_MEMBERS $(RAW_DOLLAR)0)
-DDOC_PARAMS    = $(RAW_DOLLAR)(B Params:)$(RAW_DOLLAR)(BR)\n$(RAW_DOLLAR)(TABLE $(RAW_DOLLAR)0)$(RAW_DOLLAR)(BR)
-DDOC_PARAM_ROW = $(RAW_DOLLAR)(TR $(RAW_DOLLAR)0)
-DDOC_PARAM_ID  = $(RAW_DOLLAR)(TD $(RAW_DOLLAR)0)
-DDOC_PARAM_DESC  = $(RAW_DOLLAR)(TD $(RAW_DOLLAR)0)
-DDOC_BLANKLINE = $(RAW_DOLLAR)(BR)$(RAW_DOLLAR)(BR)
-
-DDOC_ANCHOR  = $(LT)a name="$(RAW_DOLLAR)1"$(GT)$(LT)/a$(GT)
-DDOC_PSYMBOL = $(RAW_DOLLAR)(U $(RAW_DOLLAR)0)
-DDOC_KEYWORD = $(RAW_DOLLAR)(B $(RAW_DOLLAR)0)
-DDOC_PARAM   = $(RAW_DOLLAR)(I $(RAW_DOLLAR)0)
+DDOC_COMMENT   = $(LT)!-- $(DOLLAR)0 --$(GT)
+DDOC_DECL      = $(DOLLAR)(DT $(DOLLAR)(BIG $(DOLLAR)0))
+DDOC_DECL_DD   = $(DOLLAR)(DD $(DOLLAR)0)
+DDOC_DITTO     = $(DOLLAR)(BR)$(DOLLAR)0
+DDOC_SECTIONS  = $(DOLLAR)0
+DDOC_SUMMARY   = $(DOLLAR)0$(DOLLAR)(BR)$(DOLLAR)(BR)
+DDOC_DESCRIPTION = $(DOLLAR)0$(DOLLAR)(BR)$(DOLLAR)(BR)
+DDOC_AUTHORS   = $(DOLLAR)(B Authors:)$(DOLLAR)(BR)
+        $(DOLLAR)0$(DOLLAR)(BR)$(DOLLAR)(BR)
+DDOC_BUGS      = $(DOLLAR)(RED BUGS:)$(DOLLAR)(BR)
+        $(DOLLAR)0$(DOLLAR)(BR)$(DOLLAR)(BR)
+DDOC_COPYRIGHT = $(DOLLAR)(B Copyright:)$(DOLLAR)(BR)
+        $(DOLLAR)0$(DOLLAR)(BR)$(DOLLAR)(BR)
+DDOC_DATE      = $(DOLLAR)(B Date:)$(DOLLAR)(BR)
+        $(DOLLAR)0$(DOLLAR)(BR)$(DOLLAR)(BR)
+DDOC_DEPRECATED = $(DOLLAR)(RED Deprecated:)$(DOLLAR)(BR)
+        $(DOLLAR)0$(DOLLAR)(BR)$(DOLLAR)(BR)
+DDOC_EXAMPLES  = $(DOLLAR)(B Examples:)$(DOLLAR)(BR)
+        $(DOLLAR)0$(DOLLAR)(BR)$(DOLLAR)(BR)
+DDOC_HISTORY   = $(DOLLAR)(B History:)$(DOLLAR)(BR)
+        $(DOLLAR)0$(DOLLAR)(BR)$(DOLLAR)(BR)
+DDOC_LICENSE   = $(DOLLAR)(B License:)$(DOLLAR)(BR)
+        $(DOLLAR)0$(DOLLAR)(BR)$(DOLLAR)(BR)
+DDOC_RETURNS   = $(DOLLAR)(B Returns:)$(DOLLAR)(BR)
+        $(DOLLAR)0$(DOLLAR)(BR)$(DOLLAR)(BR)
+DDOC_SEE_ALSO  = $(DOLLAR)(B See Also:)$(DOLLAR)(BR)
+        $(DOLLAR)0$(DOLLAR)(BR)$(DOLLAR)(BR)
+DDOC_STANDARDS = $(DOLLAR)(B Standards:)$(DOLLAR)(BR)
+        $(DOLLAR)0$(DOLLAR)(BR)$(DOLLAR)(BR)
+DDOC_THROWS    = $(DOLLAR)(B Throws:)$(DOLLAR)(BR)
+        $(DOLLAR)0$(DOLLAR)(BR)$(DOLLAR)(BR)
+DDOC_VERSION   = $(DOLLAR)(B Version:)$(DOLLAR)(BR)
+        $(DOLLAR)0$(DOLLAR)(BR)$(DOLLAR)(BR)
+DDOC_SECTION_H = $(DOLLAR)(B $(DOLLAR)0)$(DOLLAR)(BR)$(DOLLAR)(BR)
+DDOC_SECTION   = $(DOLLAR)0$(DOLLAR)(BR)$(DOLLAR)(BR)
+DDOC_MEMBERS   = $(DOLLAR)(DL $(DOLLAR)0)
+DDOC_MODULE_MEMBERS   = $(DOLLAR)(DDOC_MEMBERS $(DOLLAR)0)
+DDOC_CLASS_MEMBERS    = $(DOLLAR)(DDOC_MEMBERS $(DOLLAR)0)
+DDOC_STRUCT_MEMBERS   = $(DOLLAR)(DDOC_MEMBERS $(DOLLAR)0)
+DDOC_ENUM_MEMBERS     = $(DOLLAR)(DDOC_MEMBERS $(DOLLAR)0)
+DDOC_TEMPLATE_MEMBERS = $(DOLLAR)(DDOC_MEMBERS $(DOLLAR)0)
+DDOC_ENUM_BASETYPE    = $(DOLLAR)0
+DDOC_PARAMS    = $(DOLLAR)(B Params:)$(DOLLAR)(BR)\n$(DOLLAR)(TABLE $(DOLLAR)0)$(DOLLAR)(BR)
+DDOC_PARAM_ROW = $(DOLLAR)(TR $(DOLLAR)0)
+DDOC_PARAM_ID  = $(DOLLAR)(TD $(DOLLAR)0)
+DDOC_PARAM_DESC  = $(DOLLAR)(TD $(DOLLAR)0)
+DDOC_BLANKLINE = $(DOLLAR)(BR)$(DOLLAR)(BR)
+
+DDOC_ANCHOR  = $(LT)a name="$(DOLLAR)1"$(GT)$(LT)/a$(GT)
+DDOC_PSYMBOL = $(DOLLAR)(U $(DOLLAR)0)
+DDOC_PSUPER_SYMBOL = $(DOLLAR)(U $(DOLLAR)0)
+DDOC_KEYWORD = $(DOLLAR)(B $(DOLLAR)0)
+DDOC_PARAM   = $(DOLLAR)(I $(DOLLAR)0)
+
+ESCAPES = /$(LT)/</
+          /$(GT)/>/
+          /&amp/&/
+)
+
+In addition, the following macros are introduced in 2.067.0:
+$(DDOCCODE
+BACKTIP=$(BACKTIP)
+DDOC_BACKQUOTED = $(DOLLAR)(D_INLINECODE $(DOLLAR)0)
+D_INLINECODE = $(LT)pre style="display:inline;" class="d_inline_code"$(GT)$(DOLLAR)0$(LT)/pre$(GT)
 )
 
 $(P
@@ -834,8 +850,8 @@ DDOC = $(LT)!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/
     $(LT)title$(GT)$(DOLLAR)(TITLE)$(LT)/title$(GT)
     $(LT)link rel="stylesheet" type="text/css" href="style.css"$(GT)
     $(LT)/head$(GT)$(LT)body$(GT)
-    $(LT)h1$(GT)$(RAW_DOLLAR)(TITLE)$(LT)/h1$(GT)
-    $(RAW_DOLLAR)(BODY)
+    $(LT)h1$(GT)$(DOLLAR)(TITLE)$(LT)/h1$(GT)
+    $(DOLLAR)(BODY)
     $(LT)/body$(GT)$(LT)/html$(GT)
 )
 
@@ -879,13 +895,15 @@ $(P
     $(TROW $(ARGS $(D DDOC_STRUCT_MEMBERS)), $(ARGS Highlighting of all the members of a struct.))
     $(TROW $(ARGS $(D DDOC_ENUM_MEMBERS)), $(ARGS Highlighting of all the members of an enum.))
     $(TROW $(ARGS $(D DDOC_TEMPLATE_MEMBERS)), $(ARGS Highlighting of all the members of a template.))
+    $(TROW $(ARGS $(D DDOC_ENUM_BASETYPE)), $(ARGS Highlighting of the type an enum is based upon))
     $(TROW $(ARGS $(D DDOC_PARAMS)), $(ARGS Highlighting of a function parameter section.))
     $(TROW $(ARGS $(D DDOC_PARAM_ROW)), $(ARGS Highlighting of a name=value function parameter.))
     $(TROW $(ARGS $(D DDOC_PARAM_ID)), $(ARGS Highlighting of the parameter name.))
     $(TROW $(ARGS $(D DDOC_PARAM_DESC)), $(ARGS Highlighting of the parameter value.))
     $(TROW $(ARGS $(D DDOC_ANCHOR)), $(ARGS Expands to a named anchor used for hyperlinking to a
         particular declaration section. Argument $(DOLLAR)1 expands to the qualified declaration name.))
     $(TROW $(ARGS $(D DDOC_PSYMBOL)), $(ARGS Highlighting of declaration name to which a particular section is referring.))
+    $(TROW $(ARGS $(D DDOC_PSUPER_SYMBOL)), $(ARGS Highlighting of the base type of a class.))
     $(TROW $(ARGS $(D DDOC_KEYWORD)), $(ARGS Highlighting of D keywords.))
     $(TROW $(ARGS $(D DDOC_PARAM)), $(ARGS Highlighting of function parameters.))
     $(TROW $(ARGS $(D DDOC_BLANKLINE)), $(ARGS Inserts a blank line.))
@@ -896,7 +914,7 @@ $(P
 )
 
 $(DDOCCODE
-DDOC_SUMMARY = $(RAW_DOLLAR)(GREEN $(RAW_DOLLAR)0)
+DDOC_SUMMARY = $(DOLLAR)(GREEN $(DOLLAR)0)
 )
 
 $(P
@@ -997,3 +1015,5 @@ $(P
 Macros:
     TITLE=Documentation Generator
     WIKI=Ddoc
+    _= Remove the following line when 2.067.0 is used to compile the site.
+    BACKTIP=`

dlang.org.ddoc

@@ -232,7 +232,6 @@ PHOBOS=$(SPANC phobos, $(AHTTP dlang.org/phobos/std_$1.html#$2, $(TAIL $3)))
 PHOBOSSRC=$(SPANC phobos_src, $(AHTTPS github.com/D-Programming-Language/phobos/blob/master/$0, $0))
 _=
 
-RAW_DOLLAR=$
 RED=$(SPANC red, $0)
 RELATIVE_LINK2=$(ALOCAL $1, $+)
 _=

latex.ddoc

@@ -238,7 +238,6 @@ PERCENT=\%
 PHOBOS=$(LINK2 phobos/std_$1.html\#$2, $3)
 _=
 
-RAW_DOLLAR=$
 RCURL=$\}$
 RED={\color{red}$0}
 REG=$(COPY)