diff options
author | Campbell Barton <ideasman42@gmail.com> | 2021-12-10 04:11:43 +0300 |
---|---|---|
committer | Campbell Barton <ideasman42@gmail.com> | 2021-12-10 04:19:36 +0300 |
commit | 566a458950ee30f60400a7624746342d19cf9695 (patch) | |
tree | 78792e4d8bdf519d86ecd9336c5fc335f811b541 /source/blender/depsgraph/intern/node | |
parent | dffd032bc9b9cd0dbb710f1f3d3f0b14361bc267 (diff) |
Cleanup: move public doc-strings into headers for 'depsgraph'
- Added space below non doc-string comments to make it clear
these aren't comments for the symbols directly below them.
- Use doxy sections for some headers.
Ref T92709
Diffstat (limited to 'source/blender/depsgraph/intern/node')
8 files changed, 28 insertions, 10 deletions
diff --git a/source/blender/depsgraph/intern/node/deg_node.cc b/source/blender/depsgraph/intern/node/deg_node.cc index 22345a85576..8bc03d8b736 100644 --- a/source/blender/depsgraph/intern/node/deg_node.cc +++ b/source/blender/depsgraph/intern/node/deg_node.cc @@ -311,7 +311,6 @@ Node::~Node() } } -/* Generic identifier for Depsgraph Nodes. */ string Node::identifier() const { return string(nodeTypeAsString(type)) + " : " + name; diff --git a/source/blender/depsgraph/intern/node/deg_node.h b/source/blender/depsgraph/intern/node/deg_node.h index a5c58d163a7..7e093ab8765 100644 --- a/source/blender/depsgraph/intern/node/deg_node.h +++ b/source/blender/depsgraph/intern/node/deg_node.h @@ -201,6 +201,7 @@ struct Node { Node(); virtual ~Node(); + /** Generic identifier for Depsgraph Nodes. */ virtual string identifier() const; virtual void init(const ID * /*id*/, const char * /*subdata*/) diff --git a/source/blender/depsgraph/intern/node/deg_node_component.cc b/source/blender/depsgraph/intern/node/deg_node_component.cc index 7d56ef44979..b716877902c 100644 --- a/source/blender/depsgraph/intern/node/deg_node_component.cc +++ b/source/blender/depsgraph/intern/node/deg_node_component.cc @@ -43,7 +43,9 @@ namespace blender::deg { /* *********** */ /* Outer Nodes */ -/* Standard Component Methods ============================= */ +/* -------------------------------------------------------------------- */ +/** \name Standard Component Methods + * \{ */ ComponentNode::OperationIDKey::OperationIDKey() : opcode(OperationCode::OPERATION), name(""), name_tag(-1) @@ -86,7 +88,6 @@ ComponentNode::ComponentNode() operations_map = new Map<ComponentNode::OperationIDKey, OperationNode *>(); } -/* Initialize 'component' node - from pointer data given */ void ComponentNode::init(const ID * /*id*/, const char * /*subdata*/) { /* hook up eval context? */ @@ -297,9 +298,12 @@ void ComponentNode::finalize_build(Depsgraph * /*graph*/) operations_map = nullptr; } -/* Bone Component ========================================= */ +/** \} */ + +/* -------------------------------------------------------------------- */ +/** \name Bone Component + * \{ */ -/* Initialize 'bone component' node - from pointer data given */ void BoneComponentNode::init(const ID *id, const char *subdata) { /* generic component-node... */ @@ -315,7 +319,11 @@ void BoneComponentNode::init(const ID *id, const char *subdata) this->pchan = BKE_pose_channel_find_name(object->pose, subdata); } -/* Register all components. =============================== */ +/** \} */ + +/* -------------------------------------------------------------------- */ +/** \name Register All Components + * \{ */ DEG_COMPONENT_NODE_DEFINE(Animation, ANIMATION, ID_RECALC_ANIMATION); /* TODO(sergey): Is this a correct tag? */ @@ -344,7 +352,11 @@ DEG_COMPONENT_NODE_DEFINE(GenericDatablock, GENERIC_DATABLOCK, 0); DEG_COMPONENT_NODE_DEFINE(Visibility, VISIBILITY, 0); DEG_COMPONENT_NODE_DEFINE(Simulation, SIMULATION, 0); -/* Node Types Register =================================== */ +/** \} */ + +/* -------------------------------------------------------------------- */ +/** \name Node Types Register + * \{ */ void deg_register_component_depsnodes() { @@ -375,4 +387,6 @@ void deg_register_component_depsnodes() register_node_typeinfo(&DNTI_SIMULATION); } +/** \} */ + } // namespace blender::deg diff --git a/source/blender/depsgraph/intern/node/deg_node_component.h b/source/blender/depsgraph/intern/node/deg_node_component.h index 4a1841d5d63..9f108af8012 100644 --- a/source/blender/depsgraph/intern/node/deg_node_component.h +++ b/source/blender/depsgraph/intern/node/deg_node_component.h @@ -67,6 +67,7 @@ struct ComponentNode : public Node { ComponentNode(); ~ComponentNode(); + /** Initialize 'component' node - from pointer data given. */ void init(const ID *id, const char *subdata) override; virtual string identifier() const override; @@ -224,6 +225,7 @@ DEG_COMPONENT_NODE_DECLARE_GENERIC(Simulation); /* Bone Component */ struct BoneComponentNode : public ComponentNode { + /** Initialize 'bone component' node - from pointer data given. */ void init(const ID *id, const char *subdata); struct bPoseChannel *pchan; /* the bone that this component represents */ diff --git a/source/blender/depsgraph/intern/node/deg_node_id.cc b/source/blender/depsgraph/intern/node/deg_node_id.cc index 2b1ebc663fe..baad8318de2 100644 --- a/source/blender/depsgraph/intern/node/deg_node_id.cc +++ b/source/blender/depsgraph/intern/node/deg_node_id.cc @@ -73,7 +73,6 @@ uint64_t IDNode::ComponentIDKey::hash() const BLI_ghashutil_strhash_p(name)); } -/* Initialize 'id' node - from pointer data given. */ void IDNode::init(const ID *id, const char *UNUSED(subdata)) { BLI_assert(id != nullptr); diff --git a/source/blender/depsgraph/intern/node/deg_node_id.h b/source/blender/depsgraph/intern/node/deg_node_id.h index 073469598dc..257e42b8e67 100644 --- a/source/blender/depsgraph/intern/node/deg_node_id.h +++ b/source/blender/depsgraph/intern/node/deg_node_id.h @@ -58,6 +58,7 @@ struct IDNode : public Node { const char *name; }; + /** Initialize 'id' node - from pointer data given. */ virtual void init(const ID *id, const char *subdata) override; void init_copy_on_write(ID *id_cow_hint = nullptr); ~IDNode(); diff --git a/source/blender/depsgraph/intern/node/deg_node_operation.cc b/source/blender/depsgraph/intern/node/deg_node_operation.cc index c25dc6fc8d5..eaae5d2d5dc 100644 --- a/source/blender/depsgraph/intern/node/deg_node_operation.cc +++ b/source/blender/depsgraph/intern/node/deg_node_operation.cc @@ -218,8 +218,6 @@ string OperationNode::identifier() const return string(operationCodeAsString(opcode)) + "(" + name + ")"; } -/* Full node identifier, including owner name. - * used for logging and debug prints. */ string OperationNode::full_identifier() const { string owner_str = owner->owner->name; diff --git a/source/blender/depsgraph/intern/node/deg_node_operation.h b/source/blender/depsgraph/intern/node/deg_node_operation.h index a17186da941..31cbb9702ba 100644 --- a/source/blender/depsgraph/intern/node/deg_node_operation.h +++ b/source/blender/depsgraph/intern/node/deg_node_operation.h @@ -233,6 +233,10 @@ struct OperationNode : public Node { OperationNode(); virtual string identifier() const override; + /** + * Full node identifier, including owner name. + * used for logging and debug prints. + */ string full_identifier() const; virtual void tag_update(Depsgraph *graph, eUpdateSource source) override; |