Welcome to mirror list, hosted at ThFree Co, Russian Federation.

git.blender.org/blender.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorCampbell Barton <ideasman42@gmail.com>2019-06-26 05:40:22 +0300
committerCampbell Barton <ideasman42@gmail.com>2019-06-26 05:44:22 +0300
commit545610d3aae0c64ad98abb4fcb19d8958018bd76 (patch)
tree4f9d256e3e58b08faa08fb41ba28840c0fae7490 /source/blender/makesrna/RNA_access.h
parentabaf6b106d3a34512f1061dc23277f3924da7fc6 (diff)
Cleanup: un-wrap lines in headers, use doxy comments
Diffstat (limited to 'source/blender/makesrna/RNA_access.h')
-rw-r--r--source/blender/makesrna/RNA_access.h50
1 files changed, 30 insertions, 20 deletions
diff --git a/source/blender/makesrna/RNA_access.h b/source/blender/makesrna/RNA_access.h
index 5045137fd95..30e24917b83 100644
--- a/source/blender/makesrna/RNA_access.h
+++ b/source/blender/makesrna/RNA_access.h
@@ -1205,7 +1205,7 @@ bool RNA_enum_is_equal(struct bContext *C,
const char *name,
const char *enumname);
-/* lower level functions that don't use a PointerRNA */
+/* Lower level functions that don't use a PointerRNA. */
bool RNA_enum_value_from_id(const EnumPropertyItem *item, const char *identifier, int *r_value);
bool RNA_enum_id_from_value(const EnumPropertyItem *item, int value, const char **r_identifier);
bool RNA_enum_icon_from_value(const EnumPropertyItem *item, int value, int *r_icon);
@@ -1425,14 +1425,19 @@ void _RNA_warning(const char *format, ...) ATTR_PRINTF_FORMAT(1, 2);
/* Equals test. */
-/* Note: In practice, EQ_STRICT and EQ_COMPARE have same behavior currently,
- * and will yield same result. */
+/**
+ * \note In practice, #EQ_STRICT and #EQ_COMPARE have same behavior currently,
+ * and will yield same result.
+ */
typedef enum eRNACompareMode {
/* Only care about equality, not full comparison. */
- RNA_EQ_STRICT, /* set/unset ignored */
- RNA_EQ_UNSET_MATCH_ANY, /* unset property matches anything */
- RNA_EQ_UNSET_MATCH_NONE, /* unset property never matches set property */
- /* Full comparison. */
+ /** Set/unset ignored. */
+ RNA_EQ_STRICT,
+ /** Unset property matches anything. */
+ RNA_EQ_UNSET_MATCH_ANY,
+ /** Unset property never matches set property. */
+ RNA_EQ_UNSET_MATCH_NONE,
+ /** Full comparison. */
RNA_EQ_COMPARE,
} eRNACompareMode;
@@ -1448,33 +1453,38 @@ bool RNA_struct_equals(struct Main *bmain,
/* Override. */
-/* flags for RNA_struct_override_matches. */
+/** Flags for #RNA_struct_override_matches. */
typedef enum eRNAOverrideMatch {
- /* Do not compare properties that are not overridable. */
+ /** Do not compare properties that are not overridable. */
RNA_OVERRIDE_COMPARE_IGNORE_NON_OVERRIDABLE = 1 << 0,
- /* Do not compare properties that are already overridden. */
+ /** Do not compare properties that are already overridden. */
RNA_OVERRIDE_COMPARE_IGNORE_OVERRIDDEN = 1 << 1,
- /* Create new property override if needed and possible. */
+ /** Create new property override if needed and possible. */
RNA_OVERRIDE_COMPARE_CREATE = 1 << 16,
- /* Restore property's value(s) to reference ones if needed and possible. */
+ /** Restore property's value(s) to reference ones if needed and possible. */
RNA_OVERRIDE_COMPARE_RESTORE = 1 << 17,
} eRNAOverrideMatch;
typedef enum eRNAOverrideMatchResult {
- /* Some new property overrides were created to take into account
- * differences between local and reference. */
+ /**
+ * Some new property overrides were created to take into account
+ * differences between local and reference.
+ */
RNA_OVERRIDE_MATCH_RESULT_CREATED = 1 << 0,
- /* Some properties were reset to reference values. */
+ /** Some properties were reset to reference values. */
RNA_OVERRIDE_MATCH_RESULT_RESTORED = 1 << 1,
} eRNAOverrideMatchResult;
typedef enum eRNAOverrideStatus {
- RNA_OVERRIDE_STATUS_OVERRIDABLE = 1 << 0, /* The property is overridable. */
- RNA_OVERRIDE_STATUS_OVERRIDDEN = 1 << 1, /* The property is overridden. */
- RNA_OVERRIDE_STATUS_MANDATORY =
- 1 << 2, /* Overriding this property is mandatory when creating an override. */
- RNA_OVERRIDE_STATUS_LOCKED = 1 << 3, /* The override status of this property is locked. */
+ /** The property is overridable. */
+ RNA_OVERRIDE_STATUS_OVERRIDABLE = 1 << 0,
+ /** The property is overridden. */
+ RNA_OVERRIDE_STATUS_OVERRIDDEN = 1 << 1,
+ /** Overriding this property is mandatory when creating an override. */
+ RNA_OVERRIDE_STATUS_MANDATORY = 1 << 2,
+ /** The override status of this property is locked. */
+ RNA_OVERRIDE_STATUS_LOCKED = 1 << 3,
} eRNAOverrideStatus;
bool RNA_struct_override_matches(struct Main *bmain,