Cleanup: comment blocks & spelling

This commit is contained in:
Campbell Barton 2021-08-06 01:36:43 +10:00
parent 8158211198
commit ff2265f0a9
4 changed files with 17 additions and 13 deletions

View File

@ -18,8 +18,8 @@
* \ingroup GHOST
*/
/* Note: Requires OpenXR headers to be included before this one for OpenXR types (XrSpace, XrPath,
* etc.). */
/* NOTE: Requires OpenXR headers to be included before this one for OpenXR types
* (XrSpace, XrPath, etc.). */
#pragma once
@ -78,9 +78,9 @@ class GHOST_XrActionProfile {
private:
XrPath m_profile = XR_NULL_PATH;
/** Subaction data identified by user (subaction) path. */
/** Sub-action data identified by user `subaction` path. */
std::map<std::string, GHOST_XrSubactionData> m_subaction_data;
/** Bindings identified by interaction (user (subaction) + component) path. */
/** Bindings identified by interaction (user `subaction` + component) path. */
std::map<std::string, XrPath> m_bindings;
};

View File

@ -370,7 +370,7 @@ void *DilateStepOperation::initializeTileData(rcti *rect)
int bwidth = rect->xmax - rect->xmin;
int bheight = rect->ymax - rect->ymin;
/* NOTE: Cache buffer has original tilesize width, but new height.
/* NOTE: Cache buffer has original tile-size width, but new height.
* We have to calculate the additional rows in the first pass,
* to have valid data available for the second pass. */
tile_info *result = create_cache(rect->xmin, rect->xmax, ymin, ymax);

View File

@ -400,8 +400,8 @@ RNANodeQueryIDData *RNANodeQuery::ensure_id_data(const ID *id)
bool rna_prop_affects_parameters_node(const PointerRNA *ptr, const PropertyRNA *prop)
{
return prop != nullptr && RNA_property_is_idprop(prop) &&
/* ID properties in the geometry nodes modifier don't affect that parameters node. Instead
they affect the modifier and therefore the geometry node directly. */
/* ID properties in the geometry nodes modifier don't affect that parameters node.
* Instead they affect the modifier and therefore the geometry node directly. */
!RNA_struct_is_a(ptr->type, &RNA_NodesModifier);
}

View File

@ -34,7 +34,7 @@ typedef struct XrSessionSettings {
char _pad[7];
char base_pose_type; /* eXRSessionBasePoseType */
char base_pose_type; /* #eXRSessionBasePoseType */
/** Object to take the location and rotation as base position from. */
Object *base_pose_object;
float base_pose_location[3];
@ -78,22 +78,26 @@ typedef enum eXrOpFlag {
} eXrOpFlag;
typedef enum eXrActionFlag {
/** Action depends on two subaction paths (i.e. two-handed/bimanual action). */
/** Action depends on two sub-action paths (i.e. two-handed/bi-manual action). */
XR_ACTION_BIMANUAL = (1 << 0),
} eXrActionFlag;
typedef enum eXrHapticFlag {
/** Whether to apply haptics to corresponding user paths for an action and its haptic action. */
XR_HAPTIC_MATCHUSERPATHS = (1 << 0),
/** Determines how haptics will be applied ("repeat" is mutually exclusive with
"press"/"release"). */
/**
* Determines how haptics will be applied
* ("repeat" is mutually exclusive with "press"/"release").
*/
XR_HAPTIC_PRESS = (1 << 1),
XR_HAPTIC_RELEASE = (1 << 2),
XR_HAPTIC_REPEAT = (1 << 3),
} eXrHapticFlag;
/** For axis-based inputs (thumbstick/trackpad/etc). Determines the region for action execution
* (mutually exclusive per axis). */
/**
* For axis-based inputs (thumb-stick/track-pad/etc).
* Determines the region for action execution (mutually exclusive per axis).
*/
typedef enum eXrAxisFlag {
XR_AXIS0_POS = (1 << 0),
XR_AXIS0_NEG = (1 << 1),