Minor formatting, wordsmithing and typo fixes.
Project: http://git-wip-us.apache.org/repos/asf/lucy-clownfish/repo Commit: http://git-wip-us.apache.org/repos/asf/lucy-clownfish/commit/ef6d3e0f Tree: http://git-wip-us.apache.org/repos/asf/lucy-clownfish/tree/ef6d3e0f Diff: http://git-wip-us.apache.org/repos/asf/lucy-clownfish/diff/ef6d3e0f Branch: refs/heads/master Commit: ef6d3e0fde6f3929e8865888508f5ef81503ddb1 Parents: 8802f65 Author: Marvin Humphrey <[email protected]> Authored: Thu Feb 25 19:33:24 2016 -0800 Committer: Marvin Humphrey <[email protected]> Committed: Thu Feb 25 19:33:55 2016 -0800 ---------------------------------------------------------------------- runtime/core/Clownfish/Hash.cfh | 12 ++++++------ runtime/core/Clownfish/String.cfh | 6 +++--- runtime/core/Clownfish/Vector.cfh | 8 ++++---- 3 files changed, 13 insertions(+), 13 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/lucy-clownfish/blob/ef6d3e0f/runtime/core/Clownfish/Hash.cfh ---------------------------------------------------------------------- diff --git a/runtime/core/Clownfish/Hash.cfh b/runtime/core/Clownfish/Hash.cfh index 320138d..590d3c9 100644 --- a/runtime/core/Clownfish/Hash.cfh +++ b/runtime/core/Clownfish/Hash.cfh @@ -75,7 +75,7 @@ public final class Clownfish::Hash inherits Clownfish::Obj { /** Fetch the value associated with `key`. * - * @return the value, or NULL if `key` is not present. + * @return the value, or [](@null) if `key` is not present. */ public nullable Obj* Fetch(Hash *self, String *key); @@ -84,7 +84,7 @@ public final class Clownfish::Hash inherits Clownfish::Obj { * * @param utf8 Pointer to UTF-8 character data of the key. * @param size Size of UTF-8 character data in bytes. - * @return the value, or NULL if `key` is not present. + * @return the value, or [](@null) if `key` is not present. */ public nullable Obj* Fetch_Utf8(Hash *self, const char *utf8, size_t size); @@ -92,7 +92,7 @@ public final class Clownfish::Hash inherits Clownfish::Obj { /** Attempt to delete a key-value pair from the hash. * * @return the value if `key` exists and thus deletion - * succeeds; otherwise NULL. + * succeeds; otherwise [](@null). */ public incremented nullable Obj* Delete(Hash *self, String *key); @@ -102,7 +102,7 @@ public final class Clownfish::Hash inherits Clownfish::Obj { * @param utf8 Pointer to UTF-8 character data of the key. * @param size Size of UTF-8 character data in bytes. * @return the value if `key` exists and thus deletion - * succeeds; otherwise NULL. + * succeeds; otherwise [](@null). */ public incremented nullable Obj* Delete_Utf8(Hash *self, const char *utf8, size_t size); @@ -112,12 +112,12 @@ public final class Clownfish::Hash inherits Clownfish::Obj { public bool Has_Key(Hash *self, String *key); - /** Return a Vector of pointers to the hash's keys. + /** Return the Hash's keys. */ public incremented Vector* Keys(Hash *self); - /** Return a Vector of pointers to the hash's values. + /** Return the Hash's values. */ public incremented Vector* Values(Hash *self); http://git-wip-us.apache.org/repos/asf/lucy-clownfish/blob/ef6d3e0f/runtime/core/Clownfish/String.cfh ---------------------------------------------------------------------- diff --git a/runtime/core/Clownfish/String.cfh b/runtime/core/Clownfish/String.cfh index af63773..9d38890 100644 --- a/runtime/core/Clownfish/String.cfh +++ b/runtime/core/Clownfish/String.cfh @@ -312,21 +312,21 @@ public final class Clownfish::String nickname Str public incremented String* To_String(String *self); - /** Return a a copy of the String with Unicode whitespace characters + /** Return a copy of the String with Unicode whitespace characters * removed from both top and tail. Whitespace is any character that has * the Unicode property `White_Space`. */ public incremented String* Trim(String *self); - /** Return a a copy of the String with leading Unicode whitespace + /** Return a copy of the String with leading Unicode whitespace * removed. Whitespace is any character that has the Unicode property * `White_Space`. */ public incremented String* Trim_Top(String *self); - /** Return a a copy of the String with trailing Unicode whitespace + /** Return a copy of the String with trailing Unicode whitespace * removed. Whitespace is any character that has the Unicode property * `White_Space`. */ http://git-wip-us.apache.org/repos/asf/lucy-clownfish/blob/ef6d3e0f/runtime/core/Clownfish/Vector.cfh ---------------------------------------------------------------------- diff --git a/runtime/core/Clownfish/Vector.cfh b/runtime/core/Clownfish/Vector.cfh index b671261..608779c 100644 --- a/runtime/core/Clownfish/Vector.cfh +++ b/runtime/core/Clownfish/Vector.cfh @@ -89,7 +89,7 @@ public final class Clownfish::Vector nickname Vec inherits Clownfish::Obj { public void Store(Vector *self, size_t tick, decremented Obj *elem = NULL); - /** Replace an element in the Vector with NULL and return it. + /** Replace an element in the Vector with [](@null) and return it. * * @return the element stored at `tick` or [](@null) if `tick` is out of * bounds. @@ -97,7 +97,7 @@ public final class Clownfish::Vector nickname Vec inherits Clownfish::Obj { public incremented nullable Obj* Delete(Vector *self, size_t tick); - /** Remove `length` elements from the vector, starting at `offset`. + /** Remove `length` elements from the Vector, starting at `offset`. * Move elements over to fill in the gap. */ public void @@ -138,8 +138,8 @@ public final class Clownfish::Vector nickname Vec inherits Clownfish::Obj { size_t Get_Capacity(Vector *self); - /** Return a new vector consisting of elements from a contiguous slice. If - * the specified range is out of bounds, return an vector with fewer + /** Return a new Vector consisting of elements from a contiguous slice. If + * the specified range is out of bounds, return a Vector with fewer * elements -- potentially none. * * @param offset The index of the element to start at.
