diff options
Diffstat (limited to 'source/blender/compositor/intern/COM_Node.h')
| -rw-r--r-- | source/blender/compositor/intern/COM_Node.h | 78 |
1 files changed, 39 insertions, 39 deletions
diff --git a/source/blender/compositor/intern/COM_Node.h b/source/blender/compositor/intern/COM_Node.h index 1b78e7fec6d..f57568350c0 100644 --- a/source/blender/compositor/intern/COM_Node.h +++ b/source/blender/compositor/intern/COM_Node.h @@ -48,43 +48,43 @@ public: private: /** - * @brief stores the reference to the SDNA bNode struct + * \brief stores the reference to the SDNA bNode struct */ bNodeTree *m_editorNodeTree; /** - * @brief stores the reference to the SDNA bNode struct + * \brief stores the reference to the SDNA bNode struct */ bNode *m_editorNode; /** - * @brief the list of actual inputsockets @see NodeInput + * \brief the list of actual inputsockets \see NodeInput */ Inputs m_inputsockets; /** - * @brief the list of actual outputsockets @see NodeOutput + * \brief the list of actual outputsockets \see NodeOutput */ Outputs m_outputsockets; /** - * @brief Is this node part of the active group + * \brief Is this node part of the active group */ bool m_inActiveGroup; /** - * @brief Instance key to identify the node in an instance hash table + * \brief Instance key to identify the node in an instance hash table */ bNodeInstanceKey m_instanceKey; protected: /** - * @brief get access to the vector of input sockets + * \brief get access to the vector of input sockets */ const Inputs &getInputSockets() const { return this->m_inputsockets; } /** - * @brief get access to the vector of input sockets + * \brief get access to the vector of input sockets */ const Outputs &getOutputSockets() const { return this->m_outputsockets; } @@ -93,55 +93,55 @@ public: virtual ~Node(); /** - * @brief get the reference to the SDNA bNode struct + * \brief get the reference to the SDNA bNode struct */ bNode *getbNode() const {return m_editorNode;} /** - * @brief get the reference to the SDNA bNodeTree struct + * \brief get the reference to the SDNA bNodeTree struct */ bNodeTree *getbNodeTree() const {return m_editorNodeTree;} /** - * @brief set the reference to the bNode - * @note used in Node instances to receive the storage/settings and complex node for highlight during execution - * @param bNode + * \brief set the reference to the bNode + * \note used in Node instances to receive the storage/settings and complex node for highlight during execution + * \param bNode */ void setbNode(bNode *node) {this->m_editorNode = node;} /** - * @brief set the reference to the bNodeTree - * @param bNodeTree + * \brief set the reference to the bNodeTree + * \param bNodeTree */ void setbNodeTree(bNodeTree *nodetree) {this->m_editorNodeTree = nodetree;} /** - * @brief Return the number of input sockets of this node. + * \brief Return the number of input sockets of this node. */ const unsigned int getNumberOfInputSockets() const { return this->m_inputsockets.size(); } /** - * @brief Return the number of output sockets of this node. + * \brief Return the number of output sockets of this node. */ const unsigned int getNumberOfOutputSockets() const { return this->m_outputsockets.size(); } /** * get the reference to a certain outputsocket - * @param index + * \param index * the index of the needed outputsocket */ NodeOutput *getOutputSocket(const unsigned int index) const; /** * get the reference to the first outputsocket - * @param index + * \param index * the index of the needed outputsocket */ inline NodeOutput *getOutputSocket() const { return getOutputSocket(0); } /** * get the reference to a certain inputsocket - * @param index + * \param index * the index of the needed inputsocket */ NodeInput *getInputSocket(const unsigned int index) const; @@ -152,26 +152,26 @@ public: bool isInputNode() const { return m_inputsockets.empty(); } /** - * @brief Is this node in the active group (the group that is being edited) - * @param isInActiveGroup + * \brief Is this node in the active group (the group that is being edited) + * \param isInActiveGroup */ void setIsInActiveGroup(bool value) { this->m_inActiveGroup = value; } /** - * @brief Is this node part of the active group + * \brief Is this node part of the active group * the active group is the group that is currently being edited. When no group is edited, * the active group will be the main tree (all nodes that are not part of a group will be active) - * @return bool [false:true] + * \return bool [false:true] */ inline bool isInActiveGroup() const { return this->m_inActiveGroup; } /** - * @brief convert node to operation + * \brief convert node to operation * - * @todo this must be described further + * \todo this must be described further * - * @param system the ExecutionSystem where the operations need to be added - * @param context reference to the CompositorContext + * \param system the ExecutionSystem where the operations need to be added + * \param context reference to the CompositorContext */ virtual void convertToOperations(NodeConverter &converter, const CompositorContext &context) const = 0; @@ -191,17 +191,17 @@ public: protected: /** - * @brief add an NodeInput to the collection of inputsockets - * @note may only be called in an constructor - * @param socket the NodeInput to add + * \brief add an NodeInput to the collection of inputsockets + * \note may only be called in an constructor + * \param socket the NodeInput to add */ void addInputSocket(DataType datatype); void addInputSocket(DataType datatype, bNodeSocket *socket); /** - * @brief add an NodeOutput to the collection of outputsockets - * @note may only be called in an constructor - * @param socket the NodeOutput to add + * \brief add an NodeOutput to the collection of outputsockets + * \note may only be called in an constructor + * \param socket the NodeOutput to add */ void addOutputSocket(DataType datatype); void addOutputSocket(DataType datatype, bNodeSocket *socket); @@ -212,8 +212,8 @@ protected: /** - * @brief NodeInput are sockets that can receive data/input - * @ingroup Model + * \brief NodeInput are sockets that can receive data/input + * \ingroup Model */ class NodeInput { private: @@ -223,7 +223,7 @@ private: DataType m_datatype; /** - * @brief link connected to this NodeInput. + * \brief link connected to this NodeInput. * An input socket can only have a single link */ NodeOutput *m_link; @@ -246,8 +246,8 @@ public: /** - * @brief NodeOutput are sockets that can send data/input - * @ingroup Model + * \brief NodeOutput are sockets that can send data/input + * \ingroup Model */ class NodeOutput { private: |