Clarify Str_Trim documentation
Project: http://git-wip-us.apache.org/repos/asf/lucy-clownfish/repo Commit: http://git-wip-us.apache.org/repos/asf/lucy-clownfish/commit/f3fe0f15 Tree: http://git-wip-us.apache.org/repos/asf/lucy-clownfish/tree/f3fe0f15 Diff: http://git-wip-us.apache.org/repos/asf/lucy-clownfish/diff/f3fe0f15 Branch: refs/heads/master Commit: f3fe0f154cf44a62aba15f100b96820239fd8d4b Parents: 4df2855 Author: Nick Wellnhofer <[email protected]> Authored: Mon Feb 22 20:24:45 2016 +0100 Committer: Nick Wellnhofer <[email protected]> Committed: Mon Feb 22 20:24:45 2016 +0100 ---------------------------------------------------------------------- runtime/core/Clownfish/String.cfh | 16 +++++++++------- 1 file changed, 9 insertions(+), 7 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/lucy-clownfish/blob/f3fe0f15/runtime/core/Clownfish/String.cfh ---------------------------------------------------------------------- diff --git a/runtime/core/Clownfish/String.cfh b/runtime/core/Clownfish/String.cfh index dca2109..308fac9 100644 --- a/runtime/core/Clownfish/String.cfh +++ b/runtime/core/Clownfish/String.cfh @@ -312,21 +312,23 @@ public final class Clownfish::String nickname Str public incremented String* To_String(String *self); - /** Remove Unicode whitespace characters from both top and tail. - * Whitespace is any character that has the Unicode property - * `White_Space`. + /** Return a 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); - /** Remove leading Unicode whitespace. Whitespace is any character - * that has the Unicode property `White_Space`. + /** Return a 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); - /** Remove trailing Unicode whitespace. Whitespace is any character - * that has the Unicode property `White_Space`. + /** Return a a copy of the String with trailing Unicode whitespace + * removed. Whitespace is any character that has the Unicode property + * `White_Space`. */ public incremented String* Trim_Tail(String *self);
