summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorEugen Wissner <belka@caraus.de>2017-01-07 17:53:57 +0100
committerEugen Wissner <belka@caraus.de>2017-01-07 17:53:57 +0100
commitd6514cb51595729fd78be593fe54b7ade4888b80 (patch)
tree6d7f42a7b8d83b351dabc3ffa50a664399c8ba43
parent976eb4bfbcf7b793dddd66b7653d7fc7ebb7b416 (diff)
downloadtanya-d6514cb51595729fd78be593fe54b7ade4888b80.tar.gz
Fix Ddoc
-rw-r--r--.gitignore1
-rw-r--r--source/tanya/container/buffer.d4
-rw-r--r--source/tanya/container/vector.d22
-rw-r--r--source/tanya/memory/mmappool.d4
-rw-r--r--source/tanya/memory/types.d7
-rw-r--r--source/tanya/network/socket.d2
-rw-r--r--source/tanya/network/url.d60
7 files changed, 57 insertions, 43 deletions
diff --git a/.gitignore b/.gitignore
index 6cc196c..44d9c69 100644
--- a/.gitignore
+++ b/.gitignore
@@ -5,3 +5,4 @@
.dub
__test__*__
__test__*__.core
+/docs/
diff --git a/source/tanya/container/buffer.d b/source/tanya/container/buffer.d
index 3854606..ebe52da 100644
--- a/source/tanya/container/buffer.d
+++ b/source/tanya/container/buffer.d
@@ -632,7 +632,7 @@ struct WriteBuffer(T = ubyte)
* written.
*
* $(D_PSYMBOL opIndex) may return only part of the data. You may need
- * to call it (and set $(D_KEYWORD +=) several times until
+ * to call it and set $(D_KEYWORD +=) several times until
* $(D_PSYMBOL length) is 0. If all the data can be written,
* maximally 3 calls are required.
*
@@ -677,7 +677,7 @@ struct WriteBuffer(T = ubyte)
* written.
*
* $(D_PSYMBOL opIndex) may return only part of the data. You may need
- * to call it (and set $(D_KEYWORD +=) several times until
+ * to call it and set $(D_KEYWORD +=) several times until
* $(D_PSYMBOL length) is 0. If all the data can be written,
* maximally 3 calls are required.
*
diff --git a/source/tanya/container/vector.d b/source/tanya/container/vector.d
index 1316a96..51c2e0b 100644
--- a/source/tanya/container/vector.d
+++ b/source/tanya/container/vector.d
@@ -353,7 +353,6 @@ struct Vector(T)
*
* Params:
* len = Initial length of the vector.
- * init = Initial value to fill the vector with.
* allocator = Allocator.
*/
this(size_t len, shared Allocator allocator = defaultAllocator) @trusted
@@ -369,7 +368,14 @@ struct Vector(T)
capacity_ = length_ = len;
}
- /// Ditto.
+ /**
+ * Creates a new $(D_PSYMBOL Vector).
+ *
+ * Params:
+ * len = Initial length of the vector.
+ * init = Initial value to fill the vector with.
+ * allocator = Allocator.
+ */
this(size_t len, T init, shared Allocator allocator = defaultAllocator) @trusted
{
this(allocator);
@@ -892,7 +898,6 @@ struct Vector(T)
* Comparison for equality.
*
* Params:
- * R = Right hand side type.
* v = The vector to compare with.
*
* Returns: $(D_KEYWORD true) if the vectors are equal, $(D_KEYWORD false)
@@ -952,7 +957,16 @@ struct Vector(T)
return true;
}
- /// Ditto.
+ /**
+ * Comparison for equality.
+ *
+ * Params:
+ * R = Right hand side type.
+ * v = The vector to compare with.
+ *
+ * Returns: $(D_KEYWORD true) if the vectors are equal, $(D_KEYWORD false)
+ * otherwise.
+ */
bool opEquals(R)(Range!R v) const @trusted
if (is(Unqual!R == T))
{
diff --git a/source/tanya/memory/mmappool.d b/source/tanya/memory/mmappool.d
index 4309053..eac7418 100644
--- a/source/tanya/memory/mmappool.d
+++ b/source/tanya/memory/mmappool.d
@@ -36,7 +36,7 @@ else version (Windows)
* block as free and only if all blocks in the region are free, the complete
* region is deallocated.
*
- * ----------------------------------------------------------------------------
+ * ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
* | | | | | || | | |
* | |prev <----------- | || | | |
* | R | B | | B | || R | B | |
@@ -46,7 +46,7 @@ else version (Windows)
* | O | K | | K | prev O | K | |
* | N | -----------> next| || N | | |
* | | | | | || | | |
- * --------------------------------------------------- ------------------------
+ * ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
*/
final class MmapPool : Allocator
{
diff --git a/source/tanya/memory/types.d b/source/tanya/memory/types.d
index 5e2f974..be9c8cd 100644
--- a/source/tanya/memory/types.d
+++ b/source/tanya/memory/types.d
@@ -374,9 +374,10 @@ private unittest
* object).
*
* Params:
- * T = Type of the constructed object.
- * A = Types of the arguments to the constructor of $(D_PARAM T).
- * args = Constructor arguments of $(D_PARAM T).
+ * T = Type of the constructed object.
+ * A = Types of the arguments to the constructor of $(D_PARAM T).
+ * allocator = Allocator.
+ * args = Constructor arguments of $(D_PARAM T).
*
* Returns: Newly created $(D_PSYMBOL RefCounted!T).
*/
diff --git a/source/tanya/network/socket.d b/source/tanya/network/socket.d
index c53a8f7..eb808ba 100644
--- a/source/tanya/network/socket.d
+++ b/source/tanya/network/socket.d
@@ -812,7 +812,7 @@ abstract class Socket
* Params:
* level = Protocol level at that the option exists.
* option = Option.
- * result = Option value.
+ * value = Option value.
*
* Throws: $(D_PSYMBOL SocketException) on error.
*/
diff --git a/source/tanya/network/url.d b/source/tanya/network/url.d
index 6f0e964..d0377d4 100644
--- a/source/tanya/network/url.d
+++ b/source/tanya/network/url.d
@@ -630,32 +630,31 @@ static this()
/**
* A Unique Resource Locator.
*/
-struct URL(U = string)
- if (isSomeString!U)
+struct URL
{
/** The URL scheme. */
- U scheme;
+ const(char)[] scheme;
/** The username. */
- U user;
+ const(char)[] user;
/** The password. */
- U pass;
+ const(char)[] pass;
/** The hostname. */
- U host;
+ const(char)[] host;
/** The port number. */
ushort port;
/** The path. */
- U path;
+ const(char)[] path;
/** The query string. */
- U query;
+ const(char)[] query;
/** The anchor. */
- U fragment;
+ const(char)[] fragment;
/**
* Attempts to parse an URL from a string.
@@ -666,7 +665,7 @@ struct URL(U = string)
*
* Throws: $(D_PSYMBOL URIException) if the URL is malformed.
*/
- this(U source)
+ this(in char[] source)
{
auto value = source;
ptrdiff_t pos = -1, endPos = value.length, start;
@@ -954,7 +953,7 @@ struct URL(U = string)
*
* Returns: Whether the port could be found.
*/
- private bool parsePort(U port) pure nothrow @safe @nogc
+ private bool parsePort(in char[] port) pure nothrow @safe @nogc
{
ptrdiff_t i = 1;
float lPort = 0;
@@ -984,14 +983,14 @@ struct URL(U = string)
///
unittest
{
- auto u = URL!()("example.org");
+ auto u = URL("example.org");
assert(u.path == "example.org");
- u = URL!()("relative/path");
+ u = URL("relative/path");
assert(u.path == "relative/path");
// Host and scheme
- u = URL!()("https://example.org");
+ u = URL("https://example.org");
assert(u.scheme == "https");
assert(u.host == "example.org");
assert(u.path is null);
@@ -999,7 +998,7 @@ unittest
assert(u.fragment is null);
// With user and port and path
- u = URL!()("https://hilary:putnam@example.org:443/foo/bar");
+ u = URL("https://hilary:putnam@example.org:443/foo/bar");
assert(u.scheme == "https");
assert(u.host == "example.org");
assert(u.path == "/foo/bar");
@@ -1009,7 +1008,7 @@ unittest
assert(u.fragment is null);
// With query string
- u = URL!()("https://example.org/?login=true");
+ u = URL("https://example.org/?login=true");
assert(u.scheme == "https");
assert(u.host == "example.org");
assert(u.path == "/");
@@ -1017,14 +1016,14 @@ unittest
assert(u.fragment is null);
// With query string and fragment
- u = URL!()("https://example.org/?login=false#label");
+ u = URL("https://example.org/?login=false#label");
assert(u.scheme == "https");
assert(u.host == "example.org");
assert(u.path == "/");
assert(u.query == "login=false");
assert(u.fragment == "label");
- u = URL!()("redis://root:password@localhost:2201/path?query=value#fragment");
+ u = URL("redis://root:password@localhost:2201/path?query=value#fragment");
assert(u.scheme == "redis");
assert(u.user == "root");
assert(u.pass == "password");
@@ -1043,7 +1042,7 @@ private unittest
{
try
{
- URL!()(t[0]);
+ URL(t[0]);
assert(0);
}
catch (URIException e)
@@ -1053,7 +1052,7 @@ private unittest
}
else
{
- auto u = URL!()(t[0]);
+ auto u = URL(t[0]);
assert("scheme" in t[1] ? u.scheme == t[1]["scheme"] : u.scheme is null,
t[0]);
assert("user" in t[1] ? u.user == t[1]["user"] : u.user is null, t[0]);
@@ -1100,31 +1099,30 @@ enum Component : string
*
* Returns: Requested URL components.
*/
-URL parseURL(U)(in U source)
- if (isSomeString!U)
+URL parseURL(typeof(null) T)(in char[] source)
{
- return URL!U(source);
+ return URL(source);
}
/// Ditto.
-string parseURL(string T, U)(in U source)
- if ((T == "scheme"
+const(char)[] parseURL(immutable(char)[] T)(in char[] source)
+ if (T == "scheme"
|| T =="host"
|| T == "user"
|| T == "pass"
|| T == "path"
|| T == "query"
- || T == "fragment") && isSomeString!U)
+ || T == "fragment")
{
- auto ret = URL!U(source);
+ auto ret = URL(source);
return mixin("ret." ~ T);
}
/// Ditto.
-ushort parseURL(string T, U)(in U source)
- if (T == "port" && isSomeString!U)
+ushort parseURL(immutable(char)[] T)(in char[] source)
+ if (T == "port")
{
- auto ret = URL!U(source);
+ auto ret = URL(source);
return ret.port;
}
@@ -1158,7 +1156,7 @@ private unittest
else
{
ushort port = parseURL!(Component.port)(t[0]);
- string component = parseURL!(Component.scheme)(t[0]);
+ auto component = parseURL!(Component.scheme)(t[0]);
assert("scheme" in t[1] ? component == t[1]["scheme"] : component is null,
t[0]);
component = parseURL!(Component.user)(t[0]);