* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
- * License along with this library; if not, write to the
- * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
- * Boston, MA 02111-1307, USA.
+ * License along with this library; if not, see <http://www.gnu.org/licenses/>.
*/
#include "config.h"
* is made to see if the character found is actually valid other than
* it starts with an appropriate byte.
*
- * Return value: a pointer to the found character or %NULL.
+ * Returns: a pointer to the found character or %NULL.
*/
gchar *
g_utf8_find_prev_char (const char *str,
* is made to see if the character found is actually valid other than
* it starts with an appropriate byte.
*
- * Return value: a pointer to the found character or %NULL
+ * Returns: a pointer to the found character or %NULL
*/
gchar *
g_utf8_find_next_char (const gchar *p,
* it starts with an appropriate byte. If @p might be the first
* character of the string, you must use g_utf8_find_prev_char() instead.
*
- * Return value: a pointer to the found character
+ * Returns: a pointer to the found character
*/
gchar *
g_utf8_prev_char (const gchar *p)
* the terminating nul character. If the @max'th byte falls in the
* middle of a character, the last (partial) character is not counted.
*
- * Return value: the length of the string in characters
+ * Returns: the length of the string in characters
*/
glong
g_utf8_strlen (const gchar *p,
* valid Unicode characters, you should use g_utf8_get_char_validated()
* instead.
*
- * Return value: the resulting character
+ * Returns: the resulting character
*/
gunichar
g_utf8_get_char (const gchar *p)
* This limitation exists as this function is called frequently during
* text rendering and therefore has to be as fast as possible.
*
- * Return value: the resulting pointer
+ * Returns: the resulting pointer
*/
gchar *
g_utf8_offset_to_pointer (const gchar *str,
* Since 2.10, this function allows @pos to be before @str, and returns
* a negative offset in this case.
*
- * Return value: the resulting character offset
+ * Returns: the resulting character offset
*/
glong
g_utf8_pointer_to_offset (const gchar *str,
* must be valid UTF-8 encoded text. (Use g_utf8_validate() on all
* text before trying to use UTF-8 utility functions with it.)
*
- * Return value: @dest
+ * Returns: @dest
*/
gchar *
g_utf8_strncpy (gchar *dest,
*
* Converts a single character to UTF-8.
*
- * Return value: number of bytes written
+ * Returns: number of bytes written
*/
int
g_unichar_to_utf8 (gunichar c,
* in a UTF-8 encoded string, while limiting the search to @len bytes.
* If @len is -1, allow unbounded search.
*
- * Return value: %NULL if the string does not contain the character,
+ * Returns: %NULL if the string does not contain the character,
* otherwise, a pointer to the start of the leftmost occurrence
* of the character in the string.
*/
* in a UTF-8 encoded string, while limiting the search to @len bytes.
* If @len is -1, allow unbounded search.
*
- * Return value: %NULL if the string does not contain the character,
+ * Returns: %NULL if the string does not contain the character,
* otherwise, a pointer to the start of the rightmost occurrence
* of the character in the string.
*/
* such as characters that are out of the range of Unicode, and for
* overlong encodings of valid characters.
*
- * Return value: the resulting character. If @p points to a partial
+ * Returns: the resulting character. If @p points to a partial
* sequence at the end of a string that could begin a valid
* character (or if @max_len is zero), returns (gunichar)-2;
* otherwise, if @p does not point to a valid UTF-8 encoded
* but does no error checking on the input. A trailing 0 character
* will be added to the string after the converted text.
*
- * Return value: a pointer to a newly allocated UCS-4 string.
+ * Returns: a pointer to a newly allocated UCS-4 string.
* This value must be freed with g_free().
*/
gunichar *
* representation as UCS-4. A trailing 0 character will be added to the
* string after the converted text.
*
- * Return value: a pointer to a newly allocated UCS-4 string.
+ * Returns: a pointer to a newly allocated UCS-4 string.
* This value must be freed with g_free(). If an error occurs,
* %NULL will be returned and @error set.
*/
* Convert a string from a 32-bit fixed width representation as UCS-4.
* to UTF-8. The result will be terminated with a 0 byte.
*
- * Return value: a pointer to a newly allocated UTF-8 string.
+ * Returns: a pointer to a newly allocated UTF-8 string.
* This value must be freed with g_free(). If an error occurs,
* %NULL will be returned and @error set. In that case, @items_read
* will be set to the position of the first invalid input character.
* be correctly interpreted as UTF-16, i.e. it doesn't contain
* things unpaired surrogates.
*
- * Return value: a pointer to a newly allocated UTF-8 string.
+ * Returns: a pointer to a newly allocated UTF-8 string.
* This value must be freed with g_free(). If an error occurs,
* %NULL will be returned and @error set.
**/
* Convert a string from UTF-16 to UCS-4. The result will be
* nul-terminated.
*
- * Return value: a pointer to a newly allocated UCS-4 string.
+ * Returns: a pointer to a newly allocated UCS-4 string.
* This value must be freed with g_free(). If an error occurs,
* %NULL will be returned and @error set.
*/
* Convert a string from UTF-8 to UTF-16. A 0 character will be
* added to the result after the converted text.
*
- * Return value: a pointer to a newly allocated UTF-16 string.
+ * Returns: a pointer to a newly allocated UTF-16 string.
* This value must be freed with g_free(). If an error occurs,
* %NULL will be returned and @error set.
*/
* Convert a string from UCS-4 to UTF-16. A 0 character will be
* added to the result after the converted text.
*
- * Return value: a pointer to a newly allocated UTF-16 string.
+ * Returns: a pointer to a newly allocated UTF-16 string.
* This value must be freed with g_free(). If an error occurs,
* %NULL will be returned and @error set.
*/
* being validated otherwise).
*
* Note that g_utf8_validate() returns %FALSE if @max_len is
- * positive and any of the @max_len bytes are NUL.
+ * positive and any of the @max_len bytes are nul.
*
* Returns %TRUE if all of @str was valid. Many GLib and GTK+
- * routines <emphasis>require</emphasis> valid UTF-8 as input;
- * so data read from a file or the network should be checked
- * with g_utf8_validate() before doing anything else with it.
+ * routines require valid UTF-8 as input; so data read from a file
+ * or the network should be checked with g_utf8_validate() before
+ * doing anything else with it.
*
- * Return value: %TRUE if the text was valid UTF-8
+ * Returns: %TRUE if the text was valid UTF-8
*/
gboolean
g_utf8_validate (const char *str,
* integer values of @ch will not be valid. 0 is considered a valid
* character, though it's normally a string terminator.
*
- * Return value: %TRUE if @ch is a valid Unicode character
+ * Returns: %TRUE if @ch is a valid Unicode character
**/
gboolean
g_unichar_validate (gunichar ch)