You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@lucy.apache.org by nw...@apache.org on 2016/02/06 15:17:44 UTC
[11/14] lucy-clownfish git commit: Another round of documentation
fixes
Another round of documentation 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/fe3b37bd
Tree: http://git-wip-us.apache.org/repos/asf/lucy-clownfish/tree/fe3b37bd
Diff: http://git-wip-us.apache.org/repos/asf/lucy-clownfish/diff/fe3b37bd
Branch: refs/heads/master
Commit: fe3b37bdd386090bd908ee4862cc5e82138909ab
Parents: 6210eac
Author: Nick Wellnhofer <we...@aevum.de>
Authored: Thu Feb 4 13:27:06 2016 +0100
Committer: Nick Wellnhofer <we...@aevum.de>
Committed: Thu Feb 4 14:33:30 2016 +0100
----------------------------------------------------------------------
runtime/core/Clownfish/ByteBuf.cfh | 2 +-
runtime/core/Clownfish/CharBuf.cfh | 12 ++++++------
runtime/core/Clownfish/Err.cfh | 2 ++
runtime/core/Clownfish/Hash.cfh | 2 +-
4 files changed, 10 insertions(+), 8 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/lucy-clownfish/blob/fe3b37bd/runtime/core/Clownfish/ByteBuf.cfh
----------------------------------------------------------------------
diff --git a/runtime/core/Clownfish/ByteBuf.cfh b/runtime/core/Clownfish/ByteBuf.cfh
index a86bbb2..f07c3de 100644
--- a/runtime/core/Clownfish/ByteBuf.cfh
+++ b/runtime/core/Clownfish/ByteBuf.cfh
@@ -123,7 +123,7 @@ public final class Clownfish::ByteBuf nickname BB inherits Clownfish::Obj {
public nullable char*
Grow(ByteBuf *self, size_t capacity);
- /** Return the content of the ByteBuf as ()[Blob] and clear the ByteBuf.
+ /** Return the content of the ByteBuf as [](Blob) and clear the ByteBuf.
*/
public incremented Blob*
Yield_Blob(ByteBuf *self);
http://git-wip-us.apache.org/repos/asf/lucy-clownfish/blob/fe3b37bd/runtime/core/Clownfish/CharBuf.cfh
----------------------------------------------------------------------
diff --git a/runtime/core/Clownfish/CharBuf.cfh b/runtime/core/Clownfish/CharBuf.cfh
index 1270a2d..07faab7 100644
--- a/runtime/core/Clownfish/CharBuf.cfh
+++ b/runtime/core/Clownfish/CharBuf.cfh
@@ -69,14 +69,14 @@ public final class Clownfish::CharBuf nickname CB
/** Concatenate formatted arguments. Similar to the printf family, but
* only accepts minimal options (just enough for decent error messages).
*
- * Objects: %o
- * char*: %s
- * integers: %i8 %i32 %i64 %u8 %u32 %u64
- * floats: %f64
- * hex: %x32
+ * Objects: %o
+ * char*: %s
+ * integers: %i8 %i32 %i64 %u8 %u32 %u64
+ * floats: %f64
+ * hex: %x32
*
* Note that all Clownfish Objects, including Strings, are printed via
- * %o (which invokes [](Obj.To_String)).
+ * `%o` (which invokes [](Obj.To_String)).
*
* @param pattern The format string.
* @param args A `va_list` containing the arguments.
http://git-wip-us.apache.org/repos/asf/lucy-clownfish/blob/fe3b37bd/runtime/core/Clownfish/Err.cfh
----------------------------------------------------------------------
diff --git a/runtime/core/Clownfish/Err.cfh b/runtime/core/Clownfish/Err.cfh
index e6dce87..c05abb2 100644
--- a/runtime/core/Clownfish/Err.cfh
+++ b/runtime/core/Clownfish/Err.cfh
@@ -60,6 +60,8 @@ public class Clownfish::Err inherits Clownfish::Obj {
public void
Cat_Mess(Err *self, String *mess);
+ /** Return the error message.
+ */
public String*
Get_Mess(Err *self);
http://git-wip-us.apache.org/repos/asf/lucy-clownfish/blob/fe3b37bd/runtime/core/Clownfish/Hash.cfh
----------------------------------------------------------------------
diff --git a/runtime/core/Clownfish/Hash.cfh b/runtime/core/Clownfish/Hash.cfh
index b2fa243..473ad15 100644
--- a/runtime/core/Clownfish/Hash.cfh
+++ b/runtime/core/Clownfish/Hash.cfh
@@ -67,7 +67,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.
- * @param The Obj to store.
+ * @param value The Obj to store.
*/
public void
Store_Utf8(Hash *self, const char *utf8, size_t size,