Document To_String in each class
Project: http://git-wip-us.apache.org/repos/asf/lucy-clownfish/repo Commit: http://git-wip-us.apache.org/repos/asf/lucy-clownfish/commit/a452c422 Tree: http://git-wip-us.apache.org/repos/asf/lucy-clownfish/tree/a452c422 Diff: http://git-wip-us.apache.org/repos/asf/lucy-clownfish/diff/a452c422 Branch: refs/heads/master Commit: a452c422fb9a9e9fc0434ce38aa84af6c6881097 Parents: 08ccc75 Author: Nick Wellnhofer <wellnho...@aevum.de> Authored: Thu Feb 4 14:14:41 2016 +0100 Committer: Nick Wellnhofer <wellnho...@aevum.de> Committed: Thu Feb 4 14:34:45 2016 +0100 ---------------------------------------------------------------------- runtime/core/Clownfish/Boolean.cfh | 2 ++ runtime/core/Clownfish/CharBuf.cfh | 2 ++ runtime/core/Clownfish/Err.cfh | 2 ++ runtime/core/Clownfish/Num.cfh | 5 +++++ runtime/core/Clownfish/String.cfh | 2 ++ 5 files changed, 13 insertions(+) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/lucy-clownfish/blob/a452c422/runtime/core/Clownfish/Boolean.cfh ---------------------------------------------------------------------- diff --git a/runtime/core/Clownfish/Boolean.cfh b/runtime/core/Clownfish/Boolean.cfh index 453b414..17d637e 100644 --- a/runtime/core/Clownfish/Boolean.cfh +++ b/runtime/core/Clownfish/Boolean.cfh @@ -60,6 +60,8 @@ public final class Clownfish::Boolean nickname Bool { public bool Equals(Boolean *self, Obj *other); + /** Return "true" for true values and "false" for false values. + */ public incremented String* To_String(Boolean *self); } http://git-wip-us.apache.org/repos/asf/lucy-clownfish/blob/a452c422/runtime/core/Clownfish/CharBuf.cfh ---------------------------------------------------------------------- diff --git a/runtime/core/Clownfish/CharBuf.cfh b/runtime/core/Clownfish/CharBuf.cfh index 07faab7..e4ab770 100644 --- a/runtime/core/Clownfish/CharBuf.cfh +++ b/runtime/core/Clownfish/CharBuf.cfh @@ -124,6 +124,8 @@ public final class Clownfish::CharBuf nickname CB public void Destroy(CharBuf *self); + /** Return the content of the CharBuf as String. + */ public incremented String* To_String(CharBuf *self); http://git-wip-us.apache.org/repos/asf/lucy-clownfish/blob/a452c422/runtime/core/Clownfish/Err.cfh ---------------------------------------------------------------------- diff --git a/runtime/core/Clownfish/Err.cfh b/runtime/core/Clownfish/Err.cfh index c05abb2..8136caa 100644 --- a/runtime/core/Clownfish/Err.cfh +++ b/runtime/core/Clownfish/Err.cfh @@ -52,6 +52,8 @@ public class Clownfish::Err inherits Clownfish::Obj { public void Destroy(Err *self); + /** Return a copy of the error message. + */ public incremented String* To_String(Err *self); http://git-wip-us.apache.org/repos/asf/lucy-clownfish/blob/a452c422/runtime/core/Clownfish/Num.cfh ---------------------------------------------------------------------- diff --git a/runtime/core/Clownfish/Num.cfh b/runtime/core/Clownfish/Num.cfh index d32787c..07befa4 100644 --- a/runtime/core/Clownfish/Num.cfh +++ b/runtime/core/Clownfish/Num.cfh @@ -50,6 +50,9 @@ public final class Clownfish::Float { public int64_t To_I64(Float *self); + /** Return the Float formatted as String using `sprintf` with conversion + * specifier `%g`. + */ public incremented String* To_String(Float *self); @@ -110,6 +113,8 @@ public final class Clownfish::Integer nickname Int { public double To_F64(Integer *self); + /** Return the Integer formatted as String. + */ public incremented String* To_String(Integer *self); http://git-wip-us.apache.org/repos/asf/lucy-clownfish/blob/a452c422/runtime/core/Clownfish/String.cfh ---------------------------------------------------------------------- diff --git a/runtime/core/Clownfish/String.cfh b/runtime/core/Clownfish/String.cfh index 6272a1a..6479930 100644 --- a/runtime/core/Clownfish/String.cfh +++ b/runtime/core/Clownfish/String.cfh @@ -310,6 +310,8 @@ public final class Clownfish::String nickname Str size_t Hash_Sum(String *self); + /** Return a copy of the String. + */ public incremented String* To_String(String *self);