[Bf-blender-cvs] SVN commit: /data/svn/bf-blender [52547] trunk/blender: code cleanup: doxy comment corrections and correct own typo animation player docs.
Campbell Barton
ideasman42 at gmail.com
Mon Nov 26 01:59:14 CET 2012
Revision: 52547
http://projects.blender.org/scm/viewvc.php?view=rev&root=bf-blender&revision=52547
Author: campbellbarton
Date: 2012-11-26 00:59:11 +0000 (Mon, 26 Nov 2012)
Log Message:
-----------
code cleanup: doxy comment corrections and correct own typo animation player docs.
Modified Paths:
--------------
trunk/blender/intern/ghost/GHOST_C-api.h
trunk/blender/intern/utfconv/utfconv.h
trunk/blender/source/blender/blenlib/intern/string_utf8.c
trunk/blender/source/blender/bmesh/intern/bmesh_core.c
trunk/blender/source/blender/bmesh/intern/bmesh_operators.h
trunk/blender/source/blender/bmesh/tools/bmesh_decimate_collapse.c
trunk/blender/source/blender/bmesh/tools/bmesh_decimate_dissolve.c
trunk/blender/source/blender/compositor/intern/COM_WorkPackage.h
trunk/blender/source/blender/editors/space_node/node_edit.c
trunk/blender/source/blender/editors/space_view3d/view3d_iterators.c
trunk/blender/source/creator/creator.c
Modified: trunk/blender/intern/ghost/GHOST_C-api.h
===================================================================
--- trunk/blender/intern/ghost/GHOST_C-api.h 2012-11-25 16:52:42 UTC (rev 52546)
+++ trunk/blender/intern/ghost/GHOST_C-api.h 2012-11-26 00:59:11 UTC (rev 52547)
@@ -120,7 +120,7 @@
/**
* Removes a timer.
* \param systemhandle The handle to the system
- * \param timerTask Timer task to be removed.
+ * \param timertaskhandle Timer task to be removed.
* \return Indication of success.
*/
extern GHOST_TSuccess GHOST_RemoveTimer(GHOST_SystemHandle systemhandle,
@@ -185,7 +185,7 @@
/**
* Changes the window user data.
* \param windowhandle The handle to the window
- * \param data The window user data.
+ * \param userdata The window user data.
*/
extern void GHOST_SetWindowUserData(GHOST_WindowHandle windowhandle,
GHOST_TUserDataPtr userdata);
@@ -212,6 +212,7 @@
* Begins full screen mode.
* \param systemhandle The handle to the system
* \param setting The new setting of the display.
+ * \param stereoVisual Option for stereo display.
* \return A handle to the window displayed in full screen.
* This window is invalid after full screen has been ended.
*/
@@ -302,7 +303,7 @@
/**
* Set the shape of the cursor.
* \param windowhandle The handle to the window
- * \param cursor The new cursor shape type id.
+ * \param cursorshape The new cursor shape type id.
* \return Indication of success.
*/
extern GHOST_TSuccess GHOST_SetCursorShape(GHOST_WindowHandle windowhandle,
@@ -484,10 +485,10 @@
/**
* Changes the time user data.
* \param timertaskhandle The handle to the timertask
- * \param data The timer user data.
+ * \param userdata The timer user data.
*/
extern void GHOST_SetTimerTaskUserData(GHOST_TimerTaskHandle timertaskhandle,
- GHOST_TUserDataPtr userData);
+ GHOST_TUserDataPtr userdata);
/**
* Returns indication as to whether the window is valid.
@@ -825,7 +826,8 @@
/**
* Put data to the Clipboard
- * \param set the selection instead, X11 only feature
+ * \param buffer the string buffer to set.
+ * \param selection Set the selection instead, X11 only feature.
*/
extern void GHOST_putClipboard(GHOST_TInt8 *buffer, int selection);
Modified: trunk/blender/intern/utfconv/utfconv.h
===================================================================
--- trunk/blender/intern/utfconv/utfconv.h 2012-11-25 16:52:42 UTC (rev 52546)
+++ trunk/blender/intern/utfconv/utfconv.h 2012-11-26 00:59:11 UTC (rev 52547)
@@ -57,18 +57,18 @@
/**
* Converts utf-16 string to allocated utf-8 string
- * @params in16 utf-16 string to convert
- * @params out8 utf-8 string to string the conversion
- * @params size8 the allocated size in bytes of out8
+ * @param in16 utf-16 string to convert
+ * @param out8 utf-8 string to string the conversion
+ * @param size8 the allocated size in bytes of out8
* @return Returns any errors occured during conversion. See the block above,
*/
int conv_utf_16_to_8(const wchar_t *in16, char *out8, size_t size8);
/**
* Converts utf-8 string to allocated utf-16 string
- * @params in8 utf-8 string to convert
- * @params out16 utf-16 string to string the conversion
- * @params size16 the allocated size in wchar_t (two byte) of out16
+ * @param in8 utf-8 string to convert
+ * @param out16 utf-16 string to string the conversion
+ * @param size16 the allocated size in wchar_t (two byte) of out16
* @return Returns any errors occured during conversion. See the block above,
*/
int conv_utf_8_to_16(const char *in8, wchar_t *out16, size_t size16);
@@ -76,16 +76,16 @@
/**
* Allocates and converts the utf-8 string from utf-16
- * @params in16 utf-16 string to convert
- * @params add any additional size which will be allocated for new utf-8 string in bytes
+ * @param in16 utf-16 string to convert
+ * @param add any additional size which will be allocated for new utf-8 string in bytes
* @return New allocated and converted utf-8 string or NULL if in16 is 0.
*/
char *alloc_utf_8_from_16(const wchar_t *in16, size_t add);
/**
* Allocates and converts the utf-16 string from utf-8
- * @params in8 utf-8 string to convert
- * @params add any additional size which will be allocated for new utf-16 string in wchar_t (two bytes)
+ * @param in8 utf-8 string to convert
+ * @param add any additional size which will be allocated for new utf-16 string in wchar_t (two bytes)
* @return New allocated and converted utf-16 string or NULL if in8 is 0.
*/
wchar_t *alloc_utf16_from_8(const char *in8, size_t add);
Modified: trunk/blender/source/blender/blenlib/intern/string_utf8.c
===================================================================
--- trunk/blender/source/blender/blenlib/intern/string_utf8.c 2012-11-25 16:52:42 UTC (rev 52546)
+++ trunk/blender/source/blender/blenlib/intern/string_utf8.c 2012-11-26 00:59:11 UTC (rev 52547)
@@ -394,10 +394,10 @@
/* was g_utf8_get_char */
/**
* BLI_str_utf8_as_unicode:
- * @p a pointer to Unicode character encoded as UTF-8
+ * \param p a pointer to Unicode character encoded as UTF-8
*
* Converts a sequence of bytes encoded as UTF-8 to a Unicode character.
- * If @p does not point to a valid UTF-8 encoded character, results are
+ * If \a p does not point to a valid UTF-8 encoded character, results are
* undefined. If you are not sure that the bytes are complete
* valid Unicode characters, you should use g_utf8_get_char_validated()
* instead.
@@ -536,14 +536,14 @@
/* was g_utf8_find_prev_char */
/**
* BLI_str_find_prev_char_utf8:
- * @str: pointer to the beginning of a UTF-8 encoded string
- * @p pointer to some position within @str
+ * \param str pointer to the beginning of a UTF-8 encoded string
+ * \param p pointer to some position within \a str
*
- * Given a position @p with a UTF-8 encoded string @str, find the start
- * of the previous UTF-8 character starting before. @p Returns %NULL if no
- * UTF-8 characters are present in @str before @p
+ * Given a position \a p with a UTF-8 encoded string \a str, find the start
+ * of the previous UTF-8 character starting before. \a p Returns %NULL if no
+ * UTF-8 characters are present in \a str before \a p
*
- * @p does not have to be at the beginning of a UTF-8 character. No check
+ * \a p does not have to be at the beginning of a UTF-8 character. No check
* is made to see if the character found is actually valid other than
* it starts with an appropriate byte.
*
@@ -562,13 +562,13 @@
/* was g_utf8_find_next_char */
/**
* BLI_str_find_next_char_utf8:
- * @p a pointer to a position within a UTF-8 encoded string
- * @end a pointer to the byte following the end of the string,
+ * \param p a pointer to a position within a UTF-8 encoded string
+ * \param end a pointer to the byte following the end of the string,
* or %NULL to indicate that the string is nul-terminated.
*
- * Finds the start of the next UTF-8 character in the string after @p
+ * Finds the start of the next UTF-8 character in the string after \a p
*
- * @p does not have to be at the beginning of a UTF-8 character. No check
+ * \a p does not have to be at the beginning of a UTF-8 character. No check
* is made to see if the character found is actually valid other than
* it starts with an appropriate byte.
*
@@ -594,13 +594,13 @@
/* was g_utf8_prev_char */
/**
* BLI_str_prev_char_utf8:
- * @p a pointer to a position within a UTF-8 encoded string
+ * \param p a pointer to a position within a UTF-8 encoded string
*
- * Finds the previous UTF-8 character in the string before @p
+ * Finds the previous UTF-8 character in the string before \a p
*
- * @p does not have to be at the beginning of a UTF-8 character. No check
+ * \a p does not have to be at the beginning of a UTF-8 character. No check
* is made to see if the character found is actually valid other than
- * it starts with an appropriate byte. If @p might be the first
+ * it starts with an appropriate byte. If \a 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.
Modified: trunk/blender/source/blender/bmesh/intern/bmesh_core.c
===================================================================
--- trunk/blender/source/blender/bmesh/intern/bmesh_core.c 2012-11-25 16:52:42 UTC (rev 52546)
+++ trunk/blender/source/blender/bmesh/intern/bmesh_core.c 2012-11-26 00:59:11 UTC (rev 52547)
@@ -1334,10 +1334,10 @@
* will be attached to that end and is returned in \a r_e.
*
* \par Examples:
+ *
* <pre>
* E
* Before: OV-------------TV
- *
* E RE
* After: OV------NV-----TV
* </pre>
Modified: trunk/blender/source/blender/bmesh/intern/bmesh_operators.h
===================================================================
--- trunk/blender/source/blender/bmesh/intern/bmesh_operators.h 2012-11-25 16:52:42 UTC (rev 52546)
+++ trunk/blender/source/blender/bmesh/intern/bmesh_operators.h 2012-11-26 00:59:11 UTC (rev 52547)
@@ -83,11 +83,6 @@
SIMVERT_EDGE
};
-enum {
- OPUVC_AXIS_X = 1,
- OPUVC_AXIS_Y
-};
-
/* vertex path selection values */
enum {
VPATH_SELECT_EDGE_LENGTH = 0,
@@ -98,9 +93,6 @@
extern int bmesh_total_ops;
/*------specific operator helper functions-------*/
-
-struct Object;
-
void BM_mesh_esubdivide(BMesh *bm, const char edge_hflag,
float smooth, float fractal, float along_normal,
int numcuts,
Modified: trunk/blender/source/blender/bmesh/tools/bmesh_decimate_collapse.c
===================================================================
--- trunk/blender/source/blender/bmesh/tools/bmesh_decimate_collapse.c 2012-11-25 16:52:42 UTC (rev 52546)
+++ trunk/blender/source/blender/bmesh/tools/bmesh_decimate_collapse.c 2012-11-26 00:59:11 UTC (rev 52547)
@@ -960,7 +960,7 @@
* \brief BM_mesh_decimate
* \param bm The mesh
* \param factor face count multiplier [0 - 1]
- * \param vertex_weights Optional array of vertex aligned weights [0 - 1],
+ * \param vweights Optional array of vertex aligned weights [0 - 1],
* a vertex group is the usual source for this.
*/
void BM_mesh_decimate_collapse(BMesh *bm, const float factor, float *vweights, const int do_triangulate)
@@ Diff output truncated at 10240 characters. @@
More information about the Bf-blender-cvs
mailing list