code cleanup: doxy comment corrections and correct own typo animation player docs.

This commit is contained in:
Campbell Barton
2012-11-26 00:59:11 +00:00
parent 97b8a1f752
commit 7ef78723b7
11 changed files with 40 additions and 49 deletions

View 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.

View 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>

View 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,

View 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)

View 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)

View File

@@ -44,7 +44,7 @@ private:
unsigned int m_chunkNumber;
public:
/**
* @constructor
* constructor
* @param group the ExecutionGroup
* @param chunkNumber the number of the chunk
*/

View 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.
*

View 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
*/

View 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"