mirrors/phobos
1
0
Fork 0
mirror of https://github.com/dlang/phobos.git synced 2025-04-27 05:30:33 +03:00
Code Issues Projects Releases Packages Wiki Activity Actions

Fix issue 10893: added missing or renamed DDoc parameters (found by fix to 10236)

Browse source
This commit is contained in:
Lionello Lunesu 2013-08-31 15:36:29 +08:00
parent a2c23948b6
commit b4074054ba
15 changed files with 87 additions and 61 deletions
Download patch file Download diff file Expand all files Collapse all files

2
posix.mak
View file

@ -69,7 +69,7 @@ BIGDOC_OUTPUT_DIR = /tmp
SRC_DOCUMENTABLES = index.d $(addsuffix .d,$(STD_MODULES) $(STD_NET_MODULES) $(STD_DIGEST_MODULES) $(EXTRA_DOCUMENTABLES))
STDDOC = $(DOCSRC)/std.ddoc
BIGSTDDOC = $(DOCSRC)/std_consolidated.ddoc
DDOCFLAGS=$(MODEL_FLAG) -d -c -o- -version=StdDdoc -I$(DRUNTIME_PATH)/import $(DMDEXTRAFLAGS)
DDOCFLAGS=$(MODEL_FLAG) -w -d -c -o- -version=StdDdoc -I$(DRUNTIME_PATH)/import $(DMDEXTRAFLAGS)
# BUILD can be debug or release, but is unset by default; recursive
# invocation will set it. See the debug and release targets below.

2
std/base64.d
View file

@ -134,7 +134,7 @@ template Base64Impl(char Map62th, char Map63th, char Padding = '=')
*
* Params:
* source = an $(D InputRange) to encode.
* range = a buffer to store encoded result.
* buffer = a buffer to store encoded result.
*
* Returns:
* the encoded string that slices buffer.

1
std/cstream.d
View file

@ -38,6 +38,7 @@ class CFile : Stream {
/**
* Create the stream wrapper for the given C file.
* Params:
* cfile = a valid C $(B FILE) pointer to wrap.
* mode = a bitwise combination of $(B FileMode.In) for a readable file
* and $(B FileMode.Out) for a writeable file.
* seekable = indicates if the stream should be _seekable.

46
std/datetime.d
View file

@ -1723,9 +1723,9 @@ assert(SysTime(DateTime(-7, 4, 5, 7, 45, 2)).day == 5);
$(D DateTimeException) if the given minute are not a valid minute
of an hour.
+/
@property void minute(int minute)
@property void minute(int minutes)
{
enforceValid!"minutes"(minute);
enforceValid!"minutes"(minutes);
auto hnsecs = adjTime;
auto days = splitUnitsFromHNSecs!"days"(hnsecs);
@ -1739,7 +1739,7 @@ assert(SysTime(DateTime(-7, 4, 5, 7, 45, 2)).day == 5);
hnsecs = removeUnitsFromHNSecs!"minutes"(hnsecs);
hnsecs += convert!("hours", "hnsecs")(hour);
hnsecs += convert!("minutes", "hnsecs")(minute);
hnsecs += convert!("minutes", "hnsecs")(minutes);
if(negative)
hnsecs -= convert!("hours", "hnsecs")(24);
@ -2108,12 +2108,12 @@ assert(SysTime(DateTime(-7, 4, 5, 7, 45, 2)).day == 5);
Params:
tz = The $(D TimeZone) to set this $(D SysTime)'s time zone to.
+/
@property void timezone(immutable TimeZone timezone) pure nothrow
@property void timezone(immutable TimeZone tz) pure nothrow
{
if(timezone is null)
if(tz is null)
_timezone = LocalTime();
else
_timezone = timezone;
_timezone = tz;
}
@ -8433,10 +8433,10 @@ assert(SysTime.fromISOString("20100704T070612+8:00") ==
are +H, -H, +HH, -HH, +H:MM, -H:MM, +HH:MM, and -HH:MM.
Params:
isoString = A string formatted in the ISO Extended format for dates
and times.
tz = The time zone to convert the given time to (no
conversion occurs if null).
isoExtString = A string formatted in the ISO Extended format for dates
and times.
tz = The time zone to convert the given time to (no
conversion occurs if null).
Throws:
$(D DateTimeException) if the given string is not in the ISO format
@ -10532,6 +10532,8 @@ assert(d4 == Date(2001, 2, 28));
units = The type of units to add ("years" or "months").
value = The number of months or years to add to this
$(D Date).
allowOverflow = Whether the days should be allowed to overflow,
causing the month to increment.
Examples:
--------------------
@ -11211,7 +11213,7 @@ assert(d6 == Date(2001, 2, 28));
Params:
units = The units to add. Must be $(D "days").
value = The number of days to add to this $(D Date).
days = The number of days to add to this $(D Date).
Examples:
--------------------
@ -14609,7 +14611,7 @@ assert(TimeOfDay.fromISOString(" 123033 ") == TimeOfDay(12, 30, 33));
Whitespace is stripped from the given string.
Params:
isoString = A string formatted in the ISO Extended format for times.
isoExtString = A string formatted in the ISO Extended format for times.
Throws:
$(D DateTimeException) if the given string is not in the ISO
@ -16090,7 +16092,7 @@ assert(dt6 == DateTime(2001, 2, 28, 12, 30, 33));
Params:
units = The units to add.
value = The number of $(D_PARAM units) to add to this $(D DateTime).
days = The number of $(D_PARAM units) to add to this $(D DateTime).
Examples:
--------------------
@ -17821,8 +17823,8 @@ assert(DateTime.fromISOString(" 20100704T070612 ") ==
YYYY-MM-DDTHH:MM:SS. Whitespace is stripped from the given string.
Params:
isoString = A string formatted in the ISO Extended format for dates
and times.
isoExtString = A string formatted in the ISO Extended format for dates
and times.
Throws:
$(D DateTimeException) if the given string is not in the ISO
@ -19447,6 +19449,7 @@ assert(interval2 == Interval!Date(Date(1998, 1, 2), Date(2010, 3, 1)));
allowOverflow = Whether the days should be allowed to overflow
on $(D begin) and $(D end), causing their month
to increment.
dir = The direction in time to expand the interval.
Throws:
$(D DateTimeException) if this interval is empty or if the
@ -22090,7 +22093,6 @@ assert(interval2 == PosInfInterval!Date(Date(1995, 11, 13)));
Params:
duration = The duration to expand the interval by.
dir = The direction in time to expand the interval.
Examples:
--------------------
@ -23525,7 +23527,7 @@ public:
/++
Params:
begin = The time point which begins the interval.
end = The time point which ends the interval.
Examples:
--------------------
@ -24352,7 +24354,6 @@ assert(interval2 == NegInfInterval!Date(Date(2010, 3, 1)));
Params:
duration = The duration to expand the interval by.
dir = The direction in time to expand the interval.
Examples:
--------------------
@ -29577,7 +29578,12 @@ assert(tz.dstName == "PDT");
begin with "America".
Params:
subName = The first part of the desired time zones.
subName = The first part of the desired time zones.
tzDatabaseDir = The directory where the TZ Database files are
located. Because these files are not located on
Windows systems, provide them
and give their location here to
use $(D PosixTimeZone)s.
Throws:
$(D FileException) if it fails to read from disk.
@ -31425,7 +31431,7 @@ version(StdDdoc)
$(D FILETIME) struct.
Params:
sysTime = The $(D SysTime) to convert.
stdTime = The std time to convert.
Throws:
$(D DateTimeException) if the given value will not fit in a

4
std/digest/digest.d
View file

@ -650,7 +650,7 @@ unittest
* function.
*
* Params:
* Order= the order in which the bytes are processed (see $(LREF toHexString))
* order= the order in which the bytes are processed (see $(LREF toHexString))
* range= an $(D InputRange) with $(D ElementType) $(D ubyte), $(D ubyte[]) or $(D ubyte[num])
*
*
@ -679,7 +679,7 @@ unittest
* This overload of the hexDigest function handles arrays.
*
* Params:
* Order= the order in which the bytes are processed (see $(LREF toHexString))
* order= the order in which the bytes are processed (see $(LREF toHexString))
* data= one or more arrays of any type
*
* Examples:

13
std/encoding.d
View file

@ -1514,6 +1514,7 @@ unittest
Params:
s = the string to be counted
n = the current code point index
*/
ptrdiff_t index(E)(const(E)[] s,int n)
in
@ -1688,7 +1689,8 @@ body
Standards: Unicode 5.0, ASCII, ISO-8859-1, WINDOWS-1252
Params:
c = the code point to be encoded
c = the code point to be encoded
array = the destination array
Returns:
the number of code units written to the array
@ -1817,7 +1819,8 @@ size_t encode(E, R)(dchar c, R range)
Standards: Unicode 5.0, ASCII, ISO-8859-1, WINDOWS-1252
Params:
c = the code point to be encoded
c = the code point to be encoded
dg = the delegate to invoke for each code unit
*/
void encode(E)(dchar c, void delegate(E) dg)
in
@ -1898,7 +1901,7 @@ unittest
Standards: Unicode 5.0, ASCII, ISO-8859-1, WINDOWS-1252
Params:
d = the code point to be encoded
c = the code point to be encoded
Examples:
--------------------------------------------------------
@ -2145,7 +2148,8 @@ abstract class EncodingScheme
* The input to this function MUST be a valid code point.
*
* Params:
* c = the code point to be encoded
* c = the code point to be encoded
* buffer = the destination array
*
* Returns:
* the number of ubytes written.
@ -2333,6 +2337,7 @@ abstract class EncodingScheme
*
* Params:
* s = the string to be counted
* n = the current code point index
*/
ptrdiff_t index(const(ubyte)[] s, size_t n)
in

11
std/exception.d
View file

@ -60,6 +60,10 @@ import core.exception, core.stdc.errno;
If msg is empty, and the thrown exception has a
non-empty msg field, the exception's msg field
will be output on test failure.
file = The file where the error occurred.
Defaults to $(D __FILE__).
line = The line where the error occurred.
Defaults to $(D __LINE__).
Throws:
$(D AssertError) if the given $(D Throwable) is thrown.
@ -195,6 +199,10 @@ unittest
T = The $(D Throwable) to test for.
expression = The expression to test.
msg = Optional message to output on test failure.
file = The file where the error occurred.
Defaults to $(D __FILE__).
line = The line where the error occurred.
Defaults to $(D __LINE__).
Throws:
$(D AssertError) if the given $(D Throwable) is not thrown.
@ -1156,7 +1164,8 @@ class ErrnoException : Exception
Params:
E = The type of $(D Throwable)s to catch. Defaults to ${D Exception}
T = The return type of the expression and the error handler.
T1 = The type of the expression.
T2 = The return type of the error handler.
expression = The expression to run and return its result.
errorHandler = The handler to run if the expression throwed.

10
std/file.d
View file

@ -114,10 +114,12 @@ class FileException : Exception
in Windows, $(D_PARAM errno) in Posix).
Params:
name = Name of file for which the error occurred.
msg = Message describing the error.
file = The file where the error occurred.
line = The line where the error occurred.
name = Name of file for which the error occurred.
errno = The error number.
file = The file where the error occurred.
Defaults to $(D __FILE__).
line = The line where the error occurred.
Defaults to $(D __LINE__).
+/
version(Windows) this(in char[] name,
uint errno = .GetLastError(),

1
std/math.d
View file

@ -5486,6 +5486,7 @@ public:
* Uses Horner's rule A(x) = $(SUB a, 0) + x($(SUB a, 1) + x($(SUB a, 2)
* + x($(SUB a, 3) + ...)))
* Params:
* x = the value to evaluate.
* A = array of coefficients $(SUB a, 0), $(SUB a, 1), etc.
*/
real poly(real x, const real[] A) @trusted pure nothrow

8
std/net/curl.d
View file

@ -396,9 +396,9 @@ unittest
*
* Params:
* url = resource to post to
* putData = data to send as the body of the request. An array
* of an arbitrary type is accepted and will be cast to ubyte[]
* before sending it.
* postData = data to send as the body of the request. An array
* of an arbitrary type is accepted and will be cast to ubyte[]
* before sending it.
* conn = connection to use e.g. FTP or HTTP. The default AutoProtocol will
* guess connection type and create a new instance for this call only.
*
@ -894,7 +894,6 @@ struct ByLineBuffer(Char)
*
* Params:
* url = The url to receive content from
* postData = Data to HTTP Post
* keepTerminator = KeepTerminator.yes signals that the line terminator should be
* returned as part of the lines in the range.
* terminator = The character that terminates a line
@ -1433,7 +1432,6 @@ static struct AsyncChunkInputRange
* Params:
* url = The url to receive content from
* postData = Data to HTTP Post
* terminator = The character that terminates a line
* chunkSize = The size of the chunks
* transmitBuffers = The number of chunks buffered asynchronously
* conn = The connection to use e.g. HTTP or FTP.

13
std/process.d
View file

@ -267,7 +267,6 @@ least ensure all relevant buffers are flushed.
Params:
args = An array which contains the program name as the zeroth element
and any command-line arguments in the following elements.
program = The program name, $(I without) command-line arguments.
stdin = The standard input stream of the child process.
This can be any $(XREF stdio,File) that is opened for reading.
By default the child process inherits the parent's input
@ -1582,32 +1581,32 @@ foreach (line; pipes.stderr.byLine) errors ~= line.idup;
---
*/
ProcessPipes pipeProcess(in char[][] args,
Redirect redirectFlags = Redirect.all,
Redirect redirect = Redirect.all,
const string[string] env = null,
Config config = Config.none)
@trusted //TODO: @safe
{
return pipeProcessImpl!spawnProcess(args, redirectFlags, env, config);
return pipeProcessImpl!spawnProcess(args, redirect, env, config);
}
/// ditto
ProcessPipes pipeProcess(in char[] program,
Redirect redirectFlags = Redirect.all,
Redirect redirect = Redirect.all,
const string[string] env = null,
Config config = Config.none)
@trusted
{
return pipeProcessImpl!spawnProcess(program, redirectFlags, env, config);
return pipeProcessImpl!spawnProcess(program, redirect, env, config);
}
/// ditto
ProcessPipes pipeShell(in char[] command,
Redirect redirectFlags = Redirect.all,
Redirect redirect = Redirect.all,
const string[string] env = null,
Config config = Config.none)
@safe
{
return pipeProcessImpl!spawnShell(command, redirectFlags, env, config);
return pipeProcessImpl!spawnShell(command, redirect, env, config);
}
// Implementation of the pipeProcess() family of functions.

2
std/regex.d
View file

@ -6893,7 +6893,7 @@ public @trusted R replaceAll(R, C, RegEx)(R input, RegEx re, const(C)[] format)
returns the $(D input) itself.
Params:
s = string to search
input = string to search
re = compiled regular expression
fun = delegate to use

22
std/socket.d
View file

@ -1765,13 +1765,13 @@ public:
/**
* Construct a new $(D Internet6Address).
* Params:
* node = an IPv6 host address string in the form described in RFC 2373,
* or a host name which will be resolved using $(D getAddressInfo).
* port = (optional) service name or port number.
* addr = an IPv6 host address string in the form described in RFC 2373,
* or a host name which will be resolved using $(D getAddressInfo).
* service = (optional) service name.
*/
this(in char[] node, in char[] service = null)
this(in char[] addr, in char[] service = null)
{
auto results = getAddressInfo(node, service, AddressFamily.INET6);
auto results = getAddressInfo(addr, service, AddressFamily.INET6);
assert(results.length && results[0].family == AddressFamily.INET6);
sin6 = *cast(sockaddr_in6*)results[0].address.name;
}
@ -1783,19 +1783,19 @@ public:
* or a host name which will be resolved using $(D getAddressInfo).
* port = port number, may be $(D PORT_ANY).
*/
this(in char[] node, ushort port)
this(in char[] addr, ushort port)
{
if (port == PORT_ANY)
this(node);
this(addr);
else
this(node, to!string(port));
this(addr, to!string(port));
}
/**
* Construct a new $(D Internet6Address).
* Params:
* addr = (optional) an IPv6 host address in host byte order, or
$(D ADDR_ANY).
* $(D ADDR_ANY).
* port = port number, may be $(D PORT_ANY).
*/
this(ubyte[16] addr, ushort port)
@ -2885,7 +2885,9 @@ public:
* randomly varies on the order of 10ms.
*
* Params:
* value = The timeout duration to set. Must not be negative.
* level = The level at which a socket option is defined.
* option = Either $(D SocketOption.SNDTIMEO) or $(D SocketOption.RCVTIMEO).
* value = The timeout duration to set. Must not be negative.
*
* Throws: $(D SocketException) if setting the options fails.
*

4
std/xml.d
View file

@ -693,7 +693,7 @@ class Element : Item
* Constructs an Element from a Tag.
*
* Params:
* tag = the start or empty tag of the element.
* tag_ = the start or empty tag of the element.
*/
this(const(Tag) tag_)
{
@ -1655,7 +1655,7 @@ class DocumentParser : ElementParser
* This is enforced by the function's in contract.
*
* Params:
* xmltext = the entire XML document as text
* xmlText_ = the entire XML document as text
*
*/
this(string xmlText_)

9
std/zlib.d
View file

@ -143,9 +143,12 @@ const(void)[] compress(const(void)[] buf)
/*********************************************
* Decompresses the data in srcbuf[].
* Params: destlen = size of the uncompressed data.
* It need not be accurate, but the decompression will be faster if the exact
* size is supplied.
* Params:
* srcbuf = buffer containing the compressed data.
* destlen = size of the uncompressed data.
* It need not be accurate, but the decompression will be faster
* if the exact size is supplied.
* winbits = the base two logarithm of the maximum window size.
* Returns: the decompressed data.
*/