griefith/test2
1
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

Cleanup: quiet check_spelling_* warnings, use doxygen doc-strings

Browse Source
This commit is contained in:
Campbell Barton
2025-02-05 10:26:56 +11:00
parent 6f80dba66c
commit bc6dc89d50
8 changed files with 45 additions and 26 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
intern/ghost/intern/GHOST_WindowCocoa.mm
View File

@@ -571,15 +571,15 @@ GHOST_TSuccess GHOST_WindowCocoa::applyWindowDecorationStyle()
if (m_windowDecorationStyleFlags & GHOST_kDecorationColoredTitleBar) {
const float *background_color = m_windowDecorationStyleSettings.colored_titlebar_bg_color;
/* Titlebar background color. */
/* Title-bar background color. */
m_window.backgroundColor = [NSColor colorWithRed:background_color[0]
green:background_color[1]
blue:background_color[2]
alpha:1.0];
/* Titlebar foreground color.
* Use the value component of the titlebar background's HSV representation to determine
* whether we should use the macOS dark or light titlebar text appearance. With values below
/* Title-bar foreground color.
* Use the value component of the title-bar background's HSV representation to determine
* whether we should use the macOS dark or light title-bar text appearance. With values below
* 0.5 considered as dark themes, and values above 0.5 considered as light themes.
*/
const float hsv_v = MAX(background_color[0], MAX(background_color[1], background_color[2]));

3
source/blender/editors/animation/anim_asset_ops.cc
View File

@@ -247,7 +247,8 @@ static int create_pose_asset_local(bContext *C,
AssetMetaData &meta_data = *pose_action.id.asset_data;
asset_system::AssetLibrary *library = AS_asset_library_load(bmain, lib_ref);
/* I (christoph) don't know if a local library can fail to load. Just being defensive here */
/* NOTE(@ChrisLend): I don't know if a local library can fail to load.
* Just being defensive here. */
BLI_assert(library);
if (catalog_path[0] && library) {
const asset_system::AssetCatalog &catalog = asset::library_ensure_catalogs_in_path(

27
source/blender/makesrna/intern/rna_action.cc
View File

@@ -1363,8 +1363,10 @@ static void rna_Action_deselect_keys(bAction *act)
WM_main_add_notifier(NC_ANIMATION | ND_KEYFRAME | NA_EDITED, nullptr);
}
/* Used to check if an action (value pointer)
* is suitable to be assigned to the ID-block that is ptr. */
/**
* Used to check if an action (value pointer)
* is suitable to be assigned to the ID-block that is ptr.
*/
bool rna_Action_id_poll(PointerRNA *ptr, PointerRNA value)
{
ID *srcId = ptr->owner_id;
@@ -1393,8 +1395,10 @@ bool rna_Action_id_poll(PointerRNA *ptr, PointerRNA value)
return true;
}
/* Used to check if an action (value pointer)
* can be assigned to Action Editor given current mode. */
/**
* Used to check if an action (value pointer)
* can be assigned to Action Editor given current mode.
*/
bool rna_Action_actedit_assign_poll(PointerRNA *ptr, PointerRNA value)
{
SpaceAction *saction = (SpaceAction *)ptr->data;
@@ -1426,8 +1430,10 @@ bool rna_Action_actedit_assign_poll(PointerRNA *ptr, PointerRNA value)
return false;
}
/** Iterate the FCurves of the given bAnimContext and validate the RNA path. Sets the flag
* FCURVE_DISABLED if the path can't be resolved. */
/**
* Iterate the FCurves of the given bAnimContext and validate the RNA path. Sets the flag
* #FCURVE_DISABLED if the path can't be resolved.
*/
static void reevaluate_fcurve_errors(bAnimContext *ac)
{
/* Need to take off the flag before filtering, else the filter code would skip the FCurves, which
@@ -1582,7 +1588,8 @@ static void rna_ActionSlot_target_id_type_set(PointerRNA *ptr, int value)
action.slot_idtype_define(slot, ID_Type(value));
}
/* For API backwards compatability with pre-layered-actions (Blender 4.3 and
/**
* For API backwards compatibility with pre-layered-actions (Blender 4.3 and
* earlier), we treat `Action.id_root` as a proxy for the `target_id_type`
* property (`idtype` in DNA) of the Action's first Slot.
*
@@ -1599,12 +1606,14 @@ static int rna_Action_id_root_get(PointerRNA *ptr)
return action.slot(0)->idtype;
}
/* For API backwards compatability with pre-layered-actions (Blender 4.3 and
/**
* For API backwards compatibility with pre-layered-actions (Blender 4.3 and
* earlier), we treat `Action.id_root` as a proxy for the `target_id_type`
* property (`idtype` in DNA) of the Action's first Slot.
*
* If the Action has no slots, then a legacy slot is created and its
* `target_id_type` is set. */
* `target_id_type` is set.
*/
static void rna_Action_id_root_set(PointerRNA *ptr, int value)
{
animrig::Action &action = reinterpret_cast<bAction *>(ptr->owner_id)->wrap();

15
source/blender/windowmanager/WM_api.hh
View File

@@ -379,12 +379,15 @@ bool WM_stereo3d_enabled(wmWindow *win, bool skip_stereo3d_check);
/* Window Decoration Styles. */
/* Flags for #WM_window_decoration_set_style().
* NOTE: To be kept in sync with #GHOST_TWindowDecorationFlags. */
/**
* Flags for #WM_window_decoration_set_style().
*
* \note To be kept in sync with #GHOST_TWindowDecorationFlags.
*/
enum eWM_WindowDecorationStyleFlag {
/** No decoration styling. */
WM_WINDOW_DECORATION_STYLE_NONE = 0,
/** Colored Titlebar. */
/** Colored TitleBar. */
WM_WINDOW_DECORATION_STYLE_COLORED_TITLEBAR = (1 << 0),
};
ENUM_OPERATORS(eWM_WindowDecorationStyleFlag, WM_WINDOW_DECORATION_STYLE_COLORED_TITLEBAR)
@@ -393,10 +396,12 @@ ENUM_OPERATORS(eWM_WindowDecorationStyleFlag, WM_WINDOW_DECORATION_STYLE_COLORED
eWM_WindowDecorationStyleFlag WM_window_get_decoration_style_flags(const wmWindow *win);
void WM_window_set_decoration_style_flags(const wmWindow *win,
eWM_WindowDecorationStyleFlag style_flags);
/* Apply the window decoration style using the current style flags and by parsing style
/**
* Apply the window decoration style using the current style flags and by parsing style
* settings from the current Blender theme.
* The screen parameter is optional, and can be passed for enhanced theme parsing.
* NOTE: Avoid calling this function directly, prefer sending an NC_WINDOW WM notification instead.
*
* \note Avoid calling this function directly, prefer sending an NC_WINDOW WM notification instead.
*/
void WM_window_apply_decoration_style(const wmWindow *win, const bScreen *screen = nullptr);

4
source/blender/windowmanager/WM_toolsystem.hh
View File

@@ -34,7 +34,9 @@ struct wmWindow;
*/
#define WM_TOOLSYSTEM_SPACE_MASK_MODE_FROM_SPACE ((1 << SPACE_IMAGE) | (1 << SPACE_SEQ))
/* Values that define a category of active tool. */
/**
* Values that define a category of active tool.
*/
struct bToolKey {
int space_type;
int mode;

6
source/blender/windowmanager/intern/wm_window.cc
View File

@@ -632,8 +632,8 @@ static void wm_window_decoration_style_set_from_theme(const wmWindow *win, const
* NOTE: screen may be null. In which case, only the window is used as a theme provider. */
GHOST_WindowDecorationStyleSettings decoration_settings = {};
/* Colored Titlebar Decoration. */
/* For main windows, use the topbar color. */
/* Colored TitleBar Decoration. */
/* For main windows, use the top-bar color. */
if (WM_window_is_main_top_level(win)) {
UI_SetTheme(SPACE_TOPBAR, RGN_TYPE_HEADER);
}
@@ -2887,7 +2887,7 @@ bool WM_window_is_main_top_level(const wmWindow *win)
{
/**
* Return whether the window is a main/top-level window. In which case it is expected to contain
* global areas (topbar/statusbar).
* global areas (top-bar/status-bar).
*/
const bScreen *screen = BKE_workspace_active_screen_get(win->workspace_hook);
if ((win->parent != nullptr) || screen->temp) {

6
source/blender/windowmanager/wm_event_system.hh
View File

@@ -116,8 +116,10 @@ struct wmEventHandler_Op {
/** Store context for this handler for derived/modal handlers. */
struct {
/* To override the window, and hence the screen. Set for few cases only, usually window/screen
* can be taken from current context. */
/**
* To override the window, and hence the screen.
* Set for few cases only, usually window/screen can be taken from current context.
*/
wmWindow *win;
ScrArea *area;

2
source/blender/windowmanager/wm_surface.hh
View File

@@ -26,7 +26,7 @@ struct wmSurface {
void *customdata;
void (*draw)(bContext *);
/* To evaluate the surface's depsgraph. Called as part of the main loop. */
/** To evaluate the surface's depsgraph. Called as part of the main loop. */
void (*do_depsgraph)(bContext *C);
/** Free customdata, not the surface itself (done by wm_surface API). */
void (*free_data)(wmSurface *);