Changeset 16326 in vbox

Timestamp:

Jan 28, 2009 6:37:23 PM (16 years ago)

Author:

vboxsync

svn:sync-xref-src-repo-rev:

42161

Message:

document Utf8Str::substr

File:

• trunk/include/VBox/com/string.h (modified) (2 diffs)

trunk/include/VBox/com/string.h

@@ -7 +7 @@
 
 /*
- * Copyright (C) 2006-2007 Sun Microsystems, Inc.
+ * Copyright (C) 2006-2009 Sun Microsystems, Inc.
  *
  * This file is part of VirtualBox Open Source Edition (OSE), as
@@ -502 +502 @@
     static const size_t npos;
 
+    /**
+     * Returns a substring of "this" as a new Utf8Str. Works exactly like
+     * its equivalent in std::string except that this interprets pos and n
+     * as UTF-8 codepoints instead of bytes. With the default parameters "0"
+     * and "npos", this always copies the entire string.
+     * @param pos Index of first codepoints to copy from "this", counting from 0.
+     * @param n Number of codepoints to copy, starting with the one at "pos".
+     */
     Utf8Str substr(size_t pos = 0, size_t n = npos) const;