code cleanup: doxy comment corrections and correct own typo animation player docs.
authorCampbell Barton <ideasman42@gmail.com>
Mon, 26 Nov 2012 00:59:11 +0000 (00:59 +0000)
committerCampbell Barton <ideasman42@gmail.com>
Mon, 26 Nov 2012 00:59:11 +0000 (00:59 +0000)
intern/ghost/GHOST_C-api.h
intern/utfconv/utfconv.h
source/blender/blenlib/intern/string_utf8.c
source/blender/bmesh/intern/bmesh_core.c
source/blender/bmesh/intern/bmesh_operators.h
source/blender/bmesh/tools/bmesh_decimate_collapse.c
source/blender/bmesh/tools/bmesh_decimate_dissolve.c
source/blender/compositor/intern/COM_WorkPackage.h
source/blender/editors/space_node/node_edit.c
source/blender/editors/space_view3d/view3d_iterators.c
source/creator/creator.c

index 87ab3c013c666d8baaaa2763f6f95c23ccdaf0ff..f886dfd9d7d632d57dfb08f37a26b1c910e20984 100644 (file)
@@ -120,7 +120,7 @@ extern GHOST_TimerTaskHandle GHOST_InstallTimer(GHOST_SystemHandle systemhandle,
 /**
  * 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 @@ extern GHOST_TUserDataPtr GHOST_GetWindowUserData(GHOST_WindowHandle windowhandl
 /**
  * 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 @@ extern int GHOST_ValidWindow(GHOST_SystemHandle systemhandle,
  * 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 @@ extern GHOST_TStandardCursor GHOST_GetCursorShape(GHOST_WindowHandle windowhandl
 /**
  * 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 @@ extern GHOST_TUserDataPtr GHOST_GetTimerTaskUserData(GHOST_TimerTaskHandle timer
 /**
  * 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 @@ extern GHOST_TUns8 *GHOST_getClipboard(int selection);
 
 /**
  * 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);
 
index cf0e69170a27d1cc67e508433c23b324bc651813..ada85e274e318168667a8413fa45210a7d85ba0d 100644 (file)
@@ -57,18 +57,18 @@ size_t count_utf_16_from_8(const char *string8);
 
 /**
  * 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 @@ int conv_utf_8_to_16(const char *in8, wchar_t *out16, size_t size16);
 
 /**
  * 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);
index 16a5f03095d453d89d341595d7bf133a890224f2..bf98f2ae77cd456108dd253aec0c68d2d147c440 100644 (file)
@@ -394,10 +394,10 @@ int BLI_str_utf8_size_safe(const char *p)
 /* 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 @@ size_t BLI_str_utf8_from_unicode(unsigned int c, char *outbuf)
 /* 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 @@ char * BLI_str_find_prev_char_utf8(const char *str, const char *p)
 /* 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 @@ char *BLI_str_find_next_char_utf8(const char *p, const char *end)
 /* 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.
index 03094873e250b9f063dc7707901f2c9ece4829c8..541ac28bf1a4ed9ce6ba8f27282d7b4f788e0c5d 100644 (file)
@@ -1334,10 +1334,10 @@ BMFace *bmesh_sfme(BMesh *bm, BMFace *f, BMVert *v1, BMVert *v2,
  * 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>
index b74d97c9bb5d8247bb13791c8beaf3b00feec49e..8c478a3517f517c327583d7cb336cc62a63af25e 100644 (file)
@@ -83,11 +83,6 @@ enum {
        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 BMOpDefine *opdefines[];
 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,
index 781001508f2544408cd12bfe44d707f0be68e932..eeb1774b83b2a5113ab9d87f7cc0fb0f79fab19a 100644 (file)
@@ -960,7 +960,7 @@ static void bm_decim_edge_collapse(BMesh *bm, BMEdge *e,
  * \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)
index d2a5c580ae6b79794ef1977ea186a7250986b03b..f67f01e458530a586b4f74ea15b05c0ffec3d5df 100644 (file)
@@ -69,9 +69,6 @@ static int dissolve_elem_cmp(const void *a1, const void *a2)
        return 0;
 }
 
-/**
- * \param do_all_verts Collapse all verts between 2 faces - don't check their edge angle.
- */
 void BM_mesh_decimate_dissolve_ex(BMesh *bm, const float angle_limit, const int do_dissolve_boundaries,
                                   BMVert **vinput_arr, const int vinput_len,
                                   BMEdge **einput_arr, const int einput_len)
index 953a164e95efd2bbff05e91c29f3d37f43daaa19..2bb124a1c84180d9217d2478c8ad0dad8a0d0fde 100644 (file)
@@ -44,7 +44,7 @@ private:
        unsigned int m_chunkNumber;
 public:
        /**
-        * @constructor
+        * constructor
         * @param group the ExecutionGroup
         * @param chunkNumber the number of the chunk
         */
index 62e941d3148dd8ab0202cca6c6c6bf4b3bc50bcc..fd6d9ba80235ca0bcf132aaaad14149957646980 100644 (file)
@@ -177,7 +177,7 @@ static void compo_startjob(void *cjv, short *stop, short *do_update, float *prog
 }
 
 /**
- * \param sa_owner is the owner of the job,
+ * \param scene_owner is the owner of the job,
  * we don't use it for anything else currently so could also be a void pointer,
  * but for now keep it an 'Scene' for consistency.
  *
index b928e060ca0aebfdceee686c78f651e49b43c498..37607729d0d569de51bc9c3d83971a61eea09791 100644 (file)
@@ -20,7 +20,7 @@
  * ***** END GPL LICENSE BLOCK *****
  */
 
-/** \file blender/editors/object/view3d_iterators.c
+/** \file blender/editors/space_view3d/view3d_iterators.c
  *  \ingroup spview3d
  */
 
index ff67fe09896e8073a813a48485bdda91bf8f7ba4..0f1207a9a88331bd44940cec5772d4696e8c7569 100644 (file)
@@ -1079,7 +1079,7 @@ static void setupArguments(bContext *C, bArgs *ba, SYS_SystemHandle *syshandle)
                "\n\t\t-f <fps> <fps-base>\t\tSpecify FPS to start with"
                "\n\t\t-j <frame>\tSet frame step to <frame>"
                "\n\t\t-s <frame>\tPlay from <frame>"
-               "\n\t\t-j <frame>\tPlay until <frame>";
+               "\n\t\t-e <frame>\tPlay until <frame>";
 
        static char game_doc[] = "Game Engine specific options"
                "\n\t-g fixedtime\t\tRun on 50 hertz without dropping frames"