[Bf-blender-cvs] [ceab20d5e52] xr-actions-D9124: Cleanup: Comment style
Peter Kim
noreply at git.blender.org
Wed Oct 21 16:59:48 CEST 2020
Commit: ceab20d5e5289a36150cb6b6abecd5a45a57cff7
Author: Peter Kim
Date: Wed Oct 21 23:57:09 2020 +0900
Branches: xr-actions-D9124
https://developer.blender.org/rBceab20d5e5289a36150cb6b6abecd5a45a57cff7
Cleanup: Comment style
===================================================================
M intern/ghost/GHOST_Types.h
M intern/ghost/intern/GHOST_XrContext.h
M intern/ghost/intern/GHOST_XrSession.h
M source/blender/windowmanager/xr/intern/wm_xr_intern.h
===================================================================
diff --git a/intern/ghost/GHOST_Types.h b/intern/ghost/GHOST_Types.h
index 8c3efa33b03..5ffca42eefe 100644
--- a/intern/ghost/GHOST_Types.h
+++ b/intern/ghost/GHOST_Types.h
@@ -678,7 +678,7 @@ typedef struct GHOST_XrDrawViewInfo {
typedef struct GHOST_XrError {
const char *user_message;
- /* Whether to destroy the runtime when the error is handled.
+ /** Whether to destroy the runtime when the error is handled.
* Some errors (in particular those related to OpenXR actions)
* may not warrant aborting the current context / session. */
char destroy_runtime;
@@ -688,11 +688,11 @@ typedef struct GHOST_XrError {
typedef struct GHOST_XrActionSetInfo {
const char *name;
- /* Larger values take precedence over smaller values. */
+ /** Larger values take precedence over smaller values. */
GHOST_TUns32 priority;
} GHOST_XrActionSetInfo;
-/* XR action type. Enum values match those in OpenXR's
+/** XR action type. Enum values match those in OpenXR's
* XrActionType enum for consistency. */
typedef enum GHOST_XrActionType {
GHOST_kXrActionTypeBooleanInput = 1,
@@ -707,15 +707,15 @@ typedef struct GHOST_XrActionInfo {
GHOST_XrActionType type;
GHOST_TUns32 count_subaction_paths;
const char **subaction_paths;
- /* States for each subaction path. */
+ /** States for each subaction path. */
void *states;
- /* Previous states, stored to determine XR events. */
+ /** Previous states, stored to determine XR events. */
void *states_prev;
- /* Input threshold for float actions. */
+ /** Input threshold for float actions. */
float threshold;
- /* wmOperatorType and wmXrOpFlag, only used by wm. */
+ /** wmOperatorType and wmXrOpFlag, only used by wm. */
void *ot;
char op_flag;
} GHOST_XrActionInfo;
@@ -724,13 +724,13 @@ typedef struct GHOST_XrActionSpaceInfo {
const char *action_name;
GHOST_TUns32 count_subaction_paths;
const char **subaction_paths;
- /* Poses for each subaction path. */
+ /** Poses for each subaction path. */
GHOST_XrPose *poses;
} GHOST_XrActionSpaceInfo;
typedef struct GHOST_XrActionBinding {
const char *action_name;
- /* Interaction path: User (subaction) path + component path. */
+ /** Interaction path: User (subaction) path + component path. */
const char *interaction_path;
} GHOST_XrActionBinding;
diff --git a/intern/ghost/intern/GHOST_XrContext.h b/intern/ghost/intern/GHOST_XrContext.h
index 66e302f120d..d68eb0cd5bb 100644
--- a/intern/ghost/intern/GHOST_XrContext.h
+++ b/intern/ghost/intern/GHOST_XrContext.h
@@ -74,7 +74,7 @@ class GHOST_XrContext : public GHOST_IXrContext {
bool isSessionRunning() const override;
void drawSessionViews(void *draw_customdata) override;
- /* Needed for the GHOST C api. */
+ /** Needed for the GHOST C api. */
GHOST_XrSession *getSession() override;
const GHOST_XrSession *getSession() const override;
diff --git a/intern/ghost/intern/GHOST_XrSession.h b/intern/ghost/intern/GHOST_XrSession.h
index b86a241f877..b492cf3c96f 100644
--- a/intern/ghost/intern/GHOST_XrSession.h
+++ b/intern/ghost/intern/GHOST_XrSession.h
@@ -52,7 +52,7 @@ class GHOST_XrSession {
void draw(void *draw_customdata);
- /* Action functions to be called pre-session start.
+ /** Action functions to be called pre-session start.
* Note: The "destroy" functions can also be called post-session start. */
bool createActionSet(const GHOST_XrActionSetInfo *info);
void destroyActionSet(const char *action_set_name, bool remove_reference = true);
@@ -74,7 +74,7 @@ class GHOST_XrSession {
const GHOST_XrActionBindingsInfo *infos);
bool attachActionSets();
- /* Action functions to be called post-session start. */
+ /** Action functions to be called post-session start. */
bool syncActions(
const char *action_set_name = nullptr); /* If action_set_name is nullptr, all attached
* action sets will be synced. */
diff --git a/source/blender/windowmanager/xr/intern/wm_xr_intern.h b/source/blender/windowmanager/xr/intern/wm_xr_intern.h
index 962af41e581..44022f67a3c 100644
--- a/source/blender/windowmanager/xr/intern/wm_xr_intern.h
+++ b/source/blender/windowmanager/xr/intern/wm_xr_intern.h
@@ -126,7 +126,7 @@ typedef struct wmXrDrawData {
float eye_position_ofs[3]; /* Local/view space. */
} wmXrDrawData;
-/* Same as GHOST_XrActionInfo but with non-const strings. */
+/** Same as GHOST_XrActionInfo but with non-const strings. */
typedef struct wmXrAction {
char *name;
GHOST_XrActionType type;
More information about the Bf-blender-cvs
mailing list