correct use of See_Also

This commit is contained in:
Walter Bright 2014-12-27 16:30:07 -08:00
parent 3322f62602
commit c84ce85e35
5 changed files with 29 additions and 15 deletions

View file

@ -2985,7 +2985,8 @@ If splitting a string on whitespace and token compression is desired,
consider using $(D splitter) without specifying a separator (see overload
below).
See also $(XREF regex, splitter) for a version that splits using a regular
See_Also:
$(XREF regex, splitter) for a version that splits using a regular
expression defined separator.
*/
auto splitter(Range, Separator)(Range r, Separator s)
@ -3241,7 +3242,7 @@ Two adjacent separators are considered to surround an empty element in
the split range. Use $(D filter!(a => !a.empty)) on the result to compress
empty elements.
See also $(XREF regex, splitter) for a version that splits using a regular
See_Also: $(XREF regex, splitter) for a version that splits using a regular
expression defined separator.
*/
auto splitter(Range, Separator)(Range r, Separator s)

View file

@ -1964,7 +1964,7 @@ size_t encode(Tgt, Src, R)(in Src[] s, R range)
}
/**
Convert a string from one encoding to another. (See also to!() below).
Convert a string from one encoding to another.
The input to this function MUST be validly encoded.
This is enforced by the function's in-contract.
@ -1980,6 +1980,9 @@ size_t encode(Tgt, Src, R)(in Src[] s, R range)
s = the source string
r = the destination string
See_Also:
$(XREF conv, to)
Examples:
--------------------------------------------------------
wstring ws;

View file

@ -1015,7 +1015,7 @@ AddressInfo[] getAddressInfo(T...)(in char[] node, T options) @trusted
private AddressInfo[] getAddressInfoImpl(in char[] node, in char[] service, addrinfo* hints) @system
{
import std.array : appender;
import std.array : appender;
if (getaddrinfoPointer && freeaddrinfoPointer)
{

View file

@ -5605,7 +5605,9 @@ unittest
/**
* Check whether the tuple T is an expression tuple.
* An expression tuple only contains expressions. See also $(LREF isTypeTuple).
* An expression tuple only contains expressions.
*
* See_Also: $(LREF isTypeTuple).
*/
template isExpressionTuple(T ...)
{
@ -5650,7 +5652,9 @@ unittest
/**
* Check whether the tuple $(D T) is a type tuple.
* A type tuple only contains types. See also $(LREF isExpressionTuple).
* A type tuple only contains types.
*
* See_Also: $(LREF isExpressionTuple).
*/
template isTypeTuple(T...)
{

View file

@ -2241,7 +2241,11 @@ public:
/// Obtains a set that is the inversion of this set. See also $(LREF inverted).
/**
* Obtains a set that is the inversion of this set.
*
* See_Also: $(LREF inverted)
*/
auto opUnary(string op: "!")()
{
return this.inverted;
@ -4406,7 +4410,7 @@ public template buildTrie(Value, Key, Args...)
In other words $(LREF mapTrieIndex) should be a
monotonically increasing function that maps $(D Key) to an integer.
See also: $(XREF _algorithm, sort),
See_Also: $(XREF _algorithm, sort),
$(XREF _range, SortedRange),
$(XREF _algorithm, setUnion).
*/
@ -6083,7 +6087,7 @@ template SetSearcher(alias table, string kind)
$(D unicode.InBlockName), to search a script
use $(D unicode.ScriptName).
See also $(LREF block), $(LREF script)
See_Also: $(LREF block), $(LREF script)
and (not included in this search) $(LREF hangulSyllableType).
Example:
@ -6134,8 +6138,6 @@ template SetSearcher(alias table, string kind)
/**
Narrows down the search for sets of $(CODEPOINTS) to all Unicode blocks.
See also $(S_LINK Unicode properties, table of properties).
Note:
Here block names are unambiguous as no scripts are searched
and thus to search use simply $(D unicode.block.BlockName) notation.
@ -6147,6 +6149,8 @@ template SetSearcher(alias table, string kind)
// use .block for explicitness
assert(unicode.block.Greek_and_Coptic == unicode.InGreek_and_Coptic);
---
See_Also: $(S_LINK Unicode properties, table of properties).
*/
struct block
{
@ -6711,7 +6715,8 @@ unittest
// the usual range manipulation is possible
assert(wideOne[].filter!isMark.equal("\u0308"));
---
$(P See also $(LREF decodeGrapheme), $(LREF graphemeStride). )
See_Also: $(LREF decodeGrapheme), $(LREF graphemeStride)
+/
@trusted struct Grapheme
{
@ -6803,7 +6808,7 @@ public:
// still could be useful though
assert(g[].equal("A\u0301B"));
---
See also $(LREF Grapheme.valid) below.
See_Also: $(LREF Grapheme.valid)
+/
ref opOpAssign(string op)(dchar ch)
{
@ -7441,7 +7446,8 @@ public dchar compose(dchar first, dchar second) pure nothrow
Note:
This function also decomposes hangul syllables
as prescribed by the standard.
See also $(LREF decomposeHangul) for a restricted version
See_Also: $(LREF decomposeHangul) for a restricted version
that takes into account only hangul syllables but
no other decompositions.