Cleanup: doxy comments (use colon after parameter name)

Also remove colon after `\note`.
This commit is contained in:
Campbell Barton 2020-12-15 12:30:00 +11:00
parent 001f2c5d50
commit 612598acd7
12 changed files with 26 additions and 24 deletions

View File

@ -1052,7 +1052,7 @@ int GHOST_XrSessionIsRunning(const GHOST_XrContextHandle xr_context);
/**
* Check if \a xr_context has a session that requires an upside-down frame-buffer (compared to
* OpenGL). If true, the render result should be flipped vertically for correct output.
* \note: Only to be called after session start, may otherwise result in a false negative.
* \note Only to be called after session start, may otherwise result in a false negative.
*/
int GHOST_XrSessionNeedsUpsideDownDrawing(const GHOST_XrContextHandle xr_context);

View File

@ -82,8 +82,8 @@ static GHOST_TButtonMask convertButton(int button)
/**
* Converts Mac rawkey codes (same for Cocoa & Carbon)
* into GHOST key codes
* \param rawCode The raw physical key code
* \param recvChar the character ignoring modifiers (except for shift)
* \param rawCode: The raw physical key code
* \param recvChar: the character ignoring modifiers (except for shift)
* \return Ghost key code
*/
static GHOST_TKey convertKey(int rawCode, unichar recvChar, UInt16 keyAction)
@ -783,7 +783,7 @@ GHOST_IContext *GHOST_SystemCocoa::createOffscreenContext(GHOST_GLSettings glSet
/**
* Dispose of a context.
* \param context Pointer to the context to be disposed.
* \param context: Pointer to the context to be disposed.
* \return Indication of success.
*/
GHOST_TSuccess GHOST_SystemCocoa::disposeContext(GHOST_IContext *context)

View File

@ -422,7 +422,7 @@ finished:
/**
* Dispose of a context.
* \param context Pointer to the context to be disposed.
* \param context: Pointer to the context to be disposed.
* \return Indication of success.
*/
GHOST_TSuccess GHOST_SystemWin32::disposeContext(GHOST_IContext *context)
@ -2093,10 +2093,9 @@ GHOST_TSuccess GHOST_SystemWin32::showMessageBox(const char *title,
config.cbSize = sizeof(config);
config.hInstance = 0;
config.dwCommonButtons = 0;
config.pszMainIcon = (dialog_options & GHOST_DialogError ?
TD_ERROR_ICON :
dialog_options & GHOST_DialogWarning ? TD_WARNING_ICON :
TD_INFORMATION_ICON);
config.pszMainIcon = (dialog_options & GHOST_DialogError ? TD_ERROR_ICON :
dialog_options & GHOST_DialogWarning ? TD_WARNING_ICON :
TD_INFORMATION_ICON);
config.pszWindowTitle = L"Blender";
config.pszMainInstruction = title_16;
config.pszContent = message_16;

View File

@ -407,7 +407,7 @@ void GHOST_WindowWayland::setOpaque() const
#endif
/**
* \param type The type of rendering context create.
* \param type: The type of rendering context create.
* \return Indication of success.
*/
GHOST_Context *GHOST_WindowWayland::newDrawingContext(GHOST_TDrawingContextType type)

View File

@ -2441,7 +2441,7 @@ static void pose_proxy_sync(Object *ob, Object *from, int layer_protected)
}
/**
* \param r_last_visited_bone_p the last bone handled by the last call to this function.
* \param r_last_visited_bone_p: The last bone handled by the last call to this function.
*/
static int rebuild_pose_bone(
bPose *pose, Bone *bone, bPoseChannel *parchan, int counter, Bone **r_last_visited_bone_p)

View File

@ -5960,7 +5960,7 @@ static bConstraint *constraint_find_original_for_update(bConstraintOb *cob, bCon
* Check whether given constraint is not local (i.e. from linked data) when the object is a library
* override.
*
* \param con May be NULL, in which case we consider it as a non-local constraint case.
* \param con: May be NULL, in which case we consider it as a non-local constraint case.
*/
bool BKE_constraint_is_nonlocal_in_liboverride(const Object *ob, const bConstraint *con)
{

View File

@ -534,7 +534,7 @@ void BKE_gpencil_modifier_set_error(GpencilModifierData *md, const char *_format
* Check whether given modifier is not local (i.e. from linked data) when the object is a library
* override.
*
* \param gmd May be NULL, in which case we consider it as a non-local modifier case.
* \param gmd: May be NULL, in which case we consider it as a non-local modifier case.
*/
bool BKE_gpencil_modifier_is_nonlocal_in_liboverride(const Object *ob,
const GpencilModifierData *gmd)

View File

@ -579,7 +579,7 @@ bool BKE_modifier_is_enabled(const struct Scene *scene, ModifierData *md, int re
* Check whether given modifier is not local (i.e. from linked data) when the object is a library
* override.
*
* \param md May be NULL, in which case we consider it as a non-local modifier case.
* \param md: May be NULL, in which case we consider it as a non-local modifier case.
*/
bool BKE_modifier_is_nonlocal_in_liboverride(const Object *ob, const ModifierData *md)
{

View File

@ -1192,7 +1192,7 @@ bool BKE_nlatrack_get_bounds(NlaTrack *nlt, float bounds[2])
* Check whether given NLA track is not local (i.e. from linked data) when the object is a library
* override.
*
* \param nlt May be NULL, in which case we consider it as a non-local track case.
* \param nlt: May be NULL, in which case we consider it as a non-local track case.
*/
bool BKE_nlatrack_is_nonlocal_in_liboverride(const ID *id, const NlaTrack *nlt)
{

View File

@ -459,12 +459,14 @@ bool BKE_text_reload(Text *text)
return true;
}
/** Load a text file.
/**
* Load a text file.
*
* \param is_internal If \a true, this text data-block only exists in memory, not as a file on
* disk.
* \param is_internal: If \a true, this text data-block only exists in memory,
* not as a file on disk.
*
* \note: text data-blocks have no user by default, only the 'real user' flag. */
* \note text data-blocks have no user by default, only the 'real user' flag.
*/
Text *BKE_text_load_ex(Main *bmain, const char *file, const char *relpath, const bool is_internal)
{
unsigned char *buffer;
@ -520,7 +522,8 @@ Text *BKE_text_load_ex(Main *bmain, const char *file, const char *relpath, const
/** Load a text file.
*
* \note: text data-blocks have no user by default, only the 'real user' flag. */
* \note Text data-blocks have no user by default, only the 'real user' flag.
*/
Text *BKE_text_load(Main *bmain, const char *file, const char *relpath)
{
return BKE_text_load_ex(bmain, file, relpath, false);

View File

@ -2014,7 +2014,7 @@ static void set_constraint_expand_flag(const bContext *UNUSED(C), Panel *panel,
/**
* Function with void * argument for #uiListPanelIDFromDataFunc.
*
* \note: Constraint panel types are assumed to be named with the struct name field
* \note Constraint panel types are assumed to be named with the struct name field
* concatenated to the defined prefix.
*/
static void object_constraint_panel_id(void *md_link, char *r_name)

View File

@ -908,9 +908,9 @@ static void outliner_add_id_contents(SpaceOutliner *space_outliner,
/**
* TODO: this function needs to be split up! It's getting a bit too large...
*
* \note: "ID" is not always a real ID
* \note: If child items are only added to the tree if the item is open, the TSE_ type _must_ be
* added to #outliner_element_needs_rebuild_on_open_change().
* \note "ID" is not always a real ID.
* \note If child items are only added to the tree if the item is open,
* the `TSE_` type _must_ be added to #outliner_element_needs_rebuild_on_open_change().
*/
TreeElement *outliner_add_element(SpaceOutliner *space_outliner,
ListBase *lb,