Merge pull request #4303 from wilzbach/mref_phobos

use mref macro instead of link2
dlang · May 24, 2016 · 38a6370 · 38a6370
2 parents 9f82718 + 89a2dd5
commit 38a6370
Show file tree

Hide file tree

Showing 33 changed files with 70 additions and 79 deletions.
diff --git a/std/algorithm/comparison.d b/std/algorithm/comparison.d
@@ -1,6 +1,6 @@
 // Written in the D programming language.
 /**
-This is a submodule of $(LINK2 std_algorithm.html, std.algorithm).
+This is a submodule of $(MREF std, algorithm).
 It contains generic _comparison algorithms.
 
 $(BOOKTABLE Cheat Sheet,

diff --git a/std/algorithm/iteration.d b/std/algorithm/iteration.d
@@ -1,6 +1,6 @@
 // Written in the D programming language.
 /**
-This is a submodule of $(LINK2 std_algorithm.html, std.algorithm).
+This is a submodule of $(MREF std, algorithm).
 It contains generic _iteration algorithms.
 
 $(BOOKTABLE Cheat Sheet,

diff --git a/std/algorithm/mutation.d b/std/algorithm/mutation.d
@@ -1,6 +1,6 @@
 // Written in the D programming language.
 /**
-This is a submodule of $(LINK2 std_algorithm.html, std.algorithm).
+This is a submodule of $(MREF std, algorithm).
 It contains generic _mutation algorithms.
 
 $(BOOKTABLE Cheat Sheet,

diff --git a/std/algorithm/package.d b/std/algorithm/package.d
@@ -170,7 +170,7 @@ sort(a);                   // no predicate, "a < b" is implicit
 
 Macros:
 WIKI = Phobos/StdAlgorithm
-SUBMODULE = $(LINK2 std_algorithm_$1.html, std.algorithm.$1)
+SUBMODULE = $(MREF std, algorithm, $1)
 SUBREF = $(LINK2 std_algorithm_$1.html#.$2, $(TT $2))$(NBSP)
 
 Copyright: Andrei Alexandrescu 2008-.

diff --git a/std/algorithm/searching.d b/std/algorithm/searching.d
@@ -1,6 +1,6 @@
 // Written in the D programming language.
 /**
-This is a submodule of $(LINK2 std_algorithm.html, std.algorithm).
+This is a submodule of $(MREF std, algorithm).
 It contains generic _searching algorithms.
 
 $(BOOKTABLE Cheat Sheet,

diff --git a/std/algorithm/setops.d b/std/algorithm/setops.d
@@ -1,6 +1,6 @@
 // Written in the D programming language.
 /**
-This is a submodule of $(LINK2 std_algorithm.html, std.algorithm).
+This is a submodule of $(MREF std, algorithm).
 It contains generic algorithms that implement set operations.
 
 $(BOOKTABLE Cheat Sheet,

diff --git a/std/algorithm/sorting.d b/std/algorithm/sorting.d
@@ -1,6 +1,6 @@
 // Written in the D programming language.
 /**
-This is a submodule of $(LINK2 std_algorithm.html, std.algorithm).
+This is a submodule of $(MREF std, algorithm).
 It contains generic _sorting algorithms.
 
 $(BOOKTABLE Cheat Sheet,

diff --git a/std/ascii.d b/std/ascii.d
@@ -9,7 +9,7 @@
     to non-ASCII characters.
 
     For functions which operate on Unicode characters, see
-    $(LINK2 std_uni.html, std.uni).
+    $(MREF std, uni).
 
     References:
         $(LINK2 http://www.digitalmars.com/d/ascii-table.html, ASCII Table),

diff --git a/std/bigint.d b/std/bigint.d
@@ -920,7 +920,7 @@ public:
 
     /**
         $(D toString) is rarely directly invoked; the usual way of using it is via
-        $(LINK2 std_format.html#format, std.format.format):
+        $(REF format, std, format):
      */
     unittest
     {

diff --git a/std/complex.d b/std/complex.d
@@ -111,7 +111,7 @@ struct Complex(T)  if (isFloatingPoint!T)
     instead, it is used via $(XREF string,format), as shown in the examples
     below.  Supported format characters are 'e', 'f', 'g', 'a', and 's'.
 
-    See the $(LINK2 std_format.html, std.format) and $(XREF string, format)
+    See the $(MREF std, format) and $(XREF string, format)
     documentation for more information.
     */
     string toString() const /* TODO: @safe pure nothrow */

diff --git a/std/container/array.d b/std/container/array.d
@@ -2,7 +2,7 @@
 This module provides an $(D Array) type with deterministic memory usage not
 reliant on the GC, as an alternative to the built-in arrays.
 
-This module is a submodule of $(LINK2 std_container.html, std.container).
+This module is a submodule of $(MREF std, container).
 
 Source: $(PHOBOSSRC std/container/_array.d)
 Macros:

diff --git a/std/container/binaryheap.d b/std/container/binaryheap.d
@@ -2,7 +2,7 @@
 This module provides a $(D BinaryHeap) (aka priority queue)
 adaptor that makes a binary heap out of any user-provided random-access range.
 
-This module is a submodule of $(LINK2 std_container.html, std.container).
+This module is a submodule of $(MREF std, container).
 
 Source: $(PHOBOSSRC std/container/_binaryheap.d)
 Macros:

diff --git a/std/container/dlist.d b/std/container/dlist.d
@@ -2,7 +2,7 @@
 This module implements a generic doubly-linked list container.
 It can be used as a queue, dequeue or stack.
 
-This module is a submodule of $(LINK2 std_container.html, std.container).
+This module is a submodule of $(MREF std, container).
 
 Source: $(PHOBOSSRC std/container/_dlist.d)
 Macros:

diff --git a/std/container/package.d b/std/container/package.d
@@ -103,29 +103,29 @@ This module consists of the following submodules:
 
 $(UL
     $(LI
-        The $(LINK2 std_container_array.html, std._container.array) module provides
+        The $(MREF std, _container, array) module provides
         an array type with deterministic control of memory, not reliant on
         the GC unlike built-in arrays.
     )
     $(LI
-        The $(LINK2 std_container_binaryheap.html, std._container.binaryheap) module
+        The $(MREF std, _container, binaryheap) module
         provides a binary heap implementation that can be applied to any
         user-provided random-access range.
     )
     $(LI
-        The $(LINK2 std_container_dlist.html, std._container.dlist) module provides
+        The $(MREF std, _container, dlist) module provides
         a doubly-linked list implementation.
     )
     $(LI
-        The $(LINK2 std_container_rbtree.html, std._container.rbtree) module
+        The $(MREF std, _container, rbtree) module
         implements red-black trees.
     )
     $(LI
-        The $(LINK2 std_container_slist.html, std._container.slist) module
+        The $(MREF std, _container, slist) module
         implements singly-linked lists.
     )
     $(LI
-        The $(LINK2 std_container_util.html, std._container.util) module contains
+        The $(MREF std, _container, util) module contains
         some generic tools commonly used by _container implementations.
     )
 )
@@ -135,7 +135,7 @@ The_primary_range_of_a_container:
 While some _containers offer direct access to their elements e.g. via
 $(D opIndex), $(D c.front) or $(D c.back), access
 and modification of a _container's contents is generally done through
-its primary $(LINK2 std_range.html, range) type,
+its primary $(MREF_ALTTEXT range, std, range) type,
 which is aliased as $(D C.Range). For example, the primary range type of
 $(D Array!int) is $(D Array!int.Range).
 
@@ -168,7 +168,7 @@ array.linearRemove(array[].find(2).take(1));
 assert(array[].equal([1, 3]));
 ---
 
-When any $(LINK2 std_range.html, range) can be passed as an argument to
+When any $(MREF_ALTTEXT range, std, range) can be passed as an argument to
 a member function, the documention usually refers to the parameter's templated
 type as $(D Stuff).
 
@@ -199,10 +199,10 @@ The primitive $(D c.remove(r)) guarantees
 $(BIGOH n$(SUBSCRIPT r) log n$(SUBSCRIPT c)) complexity in the worst case and
 $(D c.linearRemove(r)) relaxes this guarantee to $(BIGOH n$(SUBSCRIPT c)).
 
-Since a sequence of elements can be removed from a $(LINK2 std_container_dlist.html, doubly linked list)
+Since a sequence of elements can be removed from a $(MREF_ALTTEXT doubly linked list,std,_container,dlist)
 in constant time, $(D DList) provides the primitive $(D c.remove(r))
 as well as $(D c.linearRemove(r)). On the other hand
-$(LINK2 std_container_array.html, Array) only offers $(D c.linearRemove(r)).
+$(MREF_ALTTEXT Array, std,_container, array) only offers $(D c.linearRemove(r)).
 
 The following table describes the common set of primitives that containers
 implement.  A _container need not implement all primitives, but if a

diff --git a/std/container/rbtree.d b/std/container/rbtree.d
@@ -1,7 +1,7 @@
 /**
 This module implements a red-black tree container.
 
-This module is a submodule of $(LINK2 std_container.html, std.container).
+This module is a submodule of $(MREF std, container).
 
 Source: $(PHOBOSSRC std/container/_rbtree.d)
 Macros:

diff --git a/std/container/slist.d b/std/container/slist.d
@@ -2,7 +2,7 @@
 This module implements a singly-linked list container.
 It can be used as a stack.
 
-This module is a submodule of $(LINK2 std_container.html, std.container).
+This module is a submodule of $(MREF std, container).
 
 Source: $(PHOBOSSRC std/container/_slist.d)
 Macros:

diff --git a/std/container/util.d b/std/container/util.d
@@ -1,7 +1,7 @@
 /**
 This module contains some common utilities used by containers.
 
-This module is a submodule of $(LINK2 std_container.html, std.container).
+This module is a submodule of $(MREF std, container).
 
 Source: $(PHOBOSSRC std/container/_util.d)
 Macros:

diff --git a/std/digest/hmac.d b/std/digest/hmac.d
@@ -8,9 +8,6 @@ the corresponding $(WEB en.wikipedia.org/wiki/Hash-based_message_authentication_
 $(SCRIPT inhibitQuickIndex = 1;)
 
 Macros:
-WIKI = Phobos/StdDigestHMAC
-SUBMODULE = $(LINK2 std_digest_$1.html, std.digest.$1)
-SUBREF = $(LINK2 std_digest_$1.html#.$2, $(TT $2))$(NBSP)
 
 License: $(WEB boost.org/LICENSE_1_0.txt, Boost License 1.0).
 

diff --git a/std/experimental/ndslice/iteration.d b/std/experimental/ndslice/iteration.d
@@ -1,7 +1,7 @@
 /**
 $(SCRIPT inhibitQuickIndex = 1;)
 
-This is a submodule of $(LINK2 std_experimental_ndslice.html, std.experimental.ndslice).
+This is a submodule of $(MREF std, experimental, ndslice).
 
 Operators only change strides and lengths of a slice.
 The range of a slice remains unmodified.
@@ -92,8 +92,7 @@ Authors:   Ilya Yaroshenko
 Source:    $(PHOBOSSRC std/_experimental/_ndslice/_iteration.d)
 
 Macros:
-SUBMODULE = $(LINK2 std_experimental_ndslice_$1.html, std.experimental.ndslice.$1)
-SUBREF = $(LINK2 std_experimental_ndslice_$1.html#.$2, $(TT $2))$(NBSP)
+SUBREF = $(REF_ALTTEXT $(TT $2), $2, std,experimental, ndslice, $1)$(NBSP)
 T2=$(TR $(TDNW $(LREF $1)) $(TD $+))
 T4=$(TR $(TDNW $(LREF $1)) $(TD $2) $(TD $3) $(TD $4))
 */

diff --git a/std/experimental/ndslice/package.d b/std/experimental/ndslice/package.d
@@ -310,8 +310,8 @@ Acknowledgements:   John Loughran Colvin
 Source:    $(PHOBOSSRC std/_experimental/_ndslice/_package.d)
 
 Macros:
-SUBMODULE = $(LINK2 std_experimental_ndslice_$1.html, std.experimental.ndslice.$1)
-SUBREF = $(LINK2 std_experimental_ndslice_$1.html#.$2, $(TT $2))$(NBSP)
+SUBMODULE = $(MREF std, experimental, ndslice, $1)
+SUBREF = $(REF_ALTTEXT $(TT $2), $2, std,experimental, ndslice, $1)$(NBSP)
 T2=$(TR $(TDNW $(LREF $1)) $(TD $+))
 T4=$(TR $(TDNW $(LREF $1)) $(TD $2) $(TD $3) $(TD $4))
 */

diff --git a/std/experimental/ndslice/selection.d b/std/experimental/ndslice/selection.d
@@ -1,7 +1,7 @@
 /**
 $(SCRIPT inhibitQuickIndex = 1;)
 
-This is a submodule of $(LINK2 std_experimental_ndslice.html, std.experimental.ndslice).
+This is a submodule of $(MREF std, experimental, ndslice).
 
 Selectors create new views and iteration patterns over the same data, without copying.
 
@@ -47,8 +47,7 @@ Authors:   Ilya Yaroshenko
 Source:    $(PHOBOSSRC std/_experimental/_ndslice/_selection.d)
 
 Macros:
-SUBMODULE = $(LINK2 std_experimental_ndslice_$1.html, std.experimental.ndslice.$1)
-SUBREF = $(LINK2 std_experimental_ndslice_$1.html#.$2, $(TT $2))$(NBSP)
+SUBREF = $(REF_ALTTEXT $(TT $2), $2, std,experimental, ndslice, $1)$(NBSP)
 T2=$(TR $(TDNW $(LREF $1)) $(TD $+))
 T4=$(TR $(TDNW $(LREF $1)) $(TD $2) $(TD $3) $(TD $4))
 */
@@ -1560,7 +1559,7 @@ pure nothrow unittest
 
 /++
 Returns a slice, the elements of which are equal to the initial multidimensional index value.
-This is multidimensional analog of $(LINK2 std_range.html#iota, std.range.iota).
+This is multidimensional analog of $(REF iota, std, range).
 For a flattened (continuous) index, see $(LREF iotaSlice).
 
 Params:

diff --git a/std/experimental/ndslice/slice.d b/std/experimental/ndslice/slice.d
@@ -1,5 +1,5 @@
 /**
-This is a submodule of $(LINK2 std_experimental_ndslice.html, std.experimental.ndslice).
+This is a submodule of $(MREF std, experimental, ndslice).
 
 License:   $(WEB www.boost.org/LICENSE_1_0.txt, Boost License 1.0).
 
@@ -8,8 +8,6 @@ Authors:   Ilya Yaroshenko
 Source:    $(PHOBOSSRC std/_experimental/_ndslice/_slice.d)
 
 Macros:
-SUBMODULE = $(LINK2 std_experimental_ndslice_$1.html, std.experimental.ndslice.$1)
-SUBREF = $(LINK2 std_experimental_ndslice_$1.html#.$2, $(TT $2))$(NBSP)
 T2=$(TR $(TDNW $(LREF $1)) $(TD $+))
 T4=$(TR $(TDNW $(LREF $1)) $(TD $2) $(TD $3) $(TD $4))
 STD = $(TD $(SMALL $0))
@@ -626,7 +624,7 @@ pure nothrow unittest
 
 /++
 Allocates an array through a specified allocator and creates an n-dimensional slice over it.
-See also $(LINK2 std_experimental_allocator.html, std.experimental.allocator).
+See also $(MREF std, experimental, allocator).
 Params:
     alloc = allocator
     lengths = list of lengths for each dimension
@@ -857,7 +855,7 @@ unittest
 }
 
 /++
-Base Exception class for $(LINK2 std_experimental_ndslice.html, std.experimental.ndslice).
+Base Exception class for $(MREF std, experimental, ndslice).
 +/
 class SliceException: Exception
 {
@@ -2562,7 +2560,7 @@ pure nothrow unittest
 
 /++
 Creating a slice from text.
-See also $(LINK2 std_format.html, std.format).
+See also $(MREF std, format).
 +/
 unittest
 {

diff --git a/std/file.d b/std/file.d
@@ -4,17 +4,17 @@
 Utilities for manipulating files and scanning directories. Functions
 in this module handle files as a unit, e.g., read or write one _file
 at a time. For opening files and manipulating them via handles refer
-to module $(LINK2 std_stdio.html,$(D std.stdio)).
+to module $(MREF std, stdio).
 
 Macros:
 WIKI = Phobos/StdFile
 
 Copyright: Copyright Digital Mars 2007 - 2011.
 See_Also:  The $(WEB ddili.org/ders/d.en/files.html, official tutorial) for an
 introduction to working with files in D, module
-$(LINK2 std_stdio.html,$(D std.stdio)) for opening files and manipulating them
-via handles, and module $(LINK2 std_path.html,$(D std.path)) for manipulating
-path strings.
+$(MREF std, stdio) for opening files and manipulating them via handles,
+and module $(MREF std, path) for manipulating path strings.
+
 License:   $(WEB boost.org/LICENSE_1_0.txt, Boost License 1.0).
 Authors:   $(WEB digitalmars.com, Walter Bright),
            $(WEB erdani.org, Andrei Alexandrescu),

diff --git a/std/format.d b/std/format.d
@@ -39,8 +39,8 @@ $(TR $(TH Function Name) $(TH Description)
     ))
 )
 
-   These two functions are publicly imported by $(LINK2 std_string.html,
-   std.string) to be easily available.
+   These two functions are publicly imported by $(MREF std, string)
+   to be easily available.
 
    The functions $(D $(LREF formatValue)) and $(D $(LREF unformatValue)) are
    used for the plumbing.

diff --git a/std/functional.d b/std/functional.d
@@ -5,8 +5,7 @@ Functions that manipulate other functions.
 
 This module provides functions for compile time function composition. These
 functions are helpful when constructing predicates for the algorithms in
-$(LINK2 std_algorithm.html, std.algorithm) or $(LINK2 std_range.html,
-std.range).
+$(MREF std, algorithm) or $(MREF std, range).
 
 $(BOOKTABLE ,
 $(TR $(TH Function Name) $(TH Description)

diff --git a/std/range/interfaces.d b/std/range/interfaces.d
@@ -1,5 +1,5 @@
 /**
-This module is a submodule of $(LINK2 std_range.html, std.range).
+This module is a submodule of $(MREF std, range).
 
 The main $(D std.range) module provides template-based tools for working with
 ranges, but sometimes an object-based interface for ranges is needed, such as
@@ -76,8 +76,9 @@ import std.traits;
  * around input ranges with element type E.  This is useful where a well-defined
  * binary interface is required, such as when a DLL function or virtual function
  * needs to accept a generic range as a parameter. Note that
- * $(LINK2 std_range_primitives.html#isInputRange, isInputRange) and friends check for conformance to structural
- * interfaces, not for implementation of these $(D interface) types.
+ * $(REF_ALTTEXT isInputRange, isInputRange, std, range, primitives)
+ * and friends check for conformance to structural interfaces
+ * not for implementation of these $(D interface) types.
  *
  * Limitations:
  *