Welcome to mirror list, hosted at ThFree Co, Russian Federation.

git.blender.org/blender.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorCampbell Barton <ideasman42@gmail.com>2012-03-02 20:05:54 +0400
committerCampbell Barton <ideasman42@gmail.com>2012-03-02 20:05:54 +0400
commit7bbf4b78313df9f6d2c760b527eb36a5d0418b82 (patch)
treeace55a086362cf5b35174d55442322a793dd32c1 /source/blender/blenlib/BLI_string.h
parentc8636ca3dd8bde1cc548ef21fb7a1fd304799164 (diff)
style cleanup
- spelling - turns out we had tessellation spelt wrong all over. - use \directive for doxy (not @directive) - remove BLI_sparsemap.h - was from bmesh merge IIRC but entire file commented and not used.
Diffstat (limited to 'source/blender/blenlib/BLI_string.h')
-rw-r--r--source/blender/blenlib/BLI_string.h42
1 files changed, 21 insertions, 21 deletions
diff --git a/source/blender/blenlib/BLI_string.h b/source/blender/blenlib/BLI_string.h
index 0f419920b21..ec36d587d92 100644
--- a/source/blender/blenlib/BLI_string.h
+++ b/source/blender/blenlib/BLI_string.h
@@ -37,30 +37,30 @@ extern "C" {
#endif
/**
- * Duplicates the cstring @a str into a newly mallocN'd
+ * Duplicates the cstring \a str into a newly mallocN'd
* string and returns it.
*
- * @param str The string to be duplicated
- * @retval Returns the duplicated string
+ * \param str The string to be duplicated
+ * \retval Returns the duplicated string
*/
char *BLI_strdup(const char *str);
/**
- * Duplicates the first @a len bytes of cstring @a str
- * into a newly mallocN'd string and returns it. @a str
+ * Duplicates the first \a len bytes of cstring \a str
+ * into a newly mallocN'd string and returns it. \a str
* is assumed to be at least len bytes long.
*
- * @param str The string to be duplicated
- * @param len The number of bytes to duplicate
- * @retval Returns the duplicated string
+ * \param str The string to be duplicated
+ * \param len The number of bytes to duplicate
+ * \retval Returns the duplicated string
*/
char *BLI_strdupn(const char *str, const size_t len);
/**
* Appends the two strings, and returns new mallocN'ed string
- * @param str1 first string for copy
- * @param str2 second string for append
- * @retval Returns dst
+ * \param str1 first string for copy
+ * \param str2 second string for append
+ * \retval Returns dst
*/
char *BLI_strdupcat(const char *str1, const char *str2);
@@ -68,11 +68,11 @@ char *BLI_strdupcat(const char *str1, const char *str2);
* Like strncpy but ensures dst is always
* '\0' terminated.
*
- * @param dst Destination for copy
- * @param src Source string to copy
- * @param maxncpy Maximum number of characters to copy (generally
+ * \param dst Destination for copy
+ * \param src Source string to copy
+ * \param maxncpy Maximum number of characters to copy (generally
* the size of dst)
- * @retval Returns dst
+ * \retval Returns dst
*/
char *BLI_strncpy(char *dst, const char *src, const size_t maxncpy);
@@ -88,14 +88,14 @@ char *BLI_strncpy(char *dst, const char *src, const size_t maxncpy);
char *BLI_getQuotedStr(const char *str, const char *prefix);
/**
- * Returns a copy of the cstring @a str into a newly mallocN'd
+ * Returns a copy of the cstring \a str into a newly mallocN'd
* string with all instances of oldText replaced with newText,
* and returns it.
*
- * @param str The string to replace occurrences of oldText in
- * @param oldText The text in the string to find and replace
- * @param newText The text in the string to find and replace
- * @retval Returns the duplicated string
+ * \param str The string to replace occurrences of oldText in
+ * \param oldText The text in the string to find and replace
+ * \param newText The text in the string to find and replace
+ * \retval Returns the duplicated string
*/
char *BLI_replacestr(char *str, const char *oldText, const char *newText);
@@ -123,7 +123,7 @@ size_t BLI_strescape(char *dst, const char *src, const size_t maxlen);
/**
* Compare two strings without regard to case.
*
- * @retval True if the strings are equal, false otherwise.
+ * \retval True if the strings are equal, false otherwise.
*/
int BLI_strcaseeq(const char *a, const char *b);