Cleanup: use doxygen sections

This commit is contained in:
2021-10-05 11:10:25 +11:00
parent 2dace5f3ef
commit 2b66b372bc
15 changed files with 392 additions and 228 deletions

View File

@@ -316,9 +316,9 @@ using nodes::OutputSocketRef;
using nodes::SocketRef;
} // namespace node_tree_ref_types
/* --------------------------------------------------------------------
* SocketRef inline methods.
*/
/* -------------------------------------------------------------------- */
/** \name #SocketRef Inline Methods
* \{ */
inline Span<const SocketRef *> SocketRef::logically_linked_sockets() const
{
@@ -457,9 +457,11 @@ template<typename T> inline T *SocketRef::default_value() const
return (T *)bsocket_->default_value;
}
/* --------------------------------------------------------------------
* InputSocketRef inline methods.
*/
/** \} */
/* -------------------------------------------------------------------- */
/** \name #InputSocketRef Inline Methods
* \{ */
inline Span<const OutputSocketRef *> InputSocketRef::logically_linked_sockets() const
{
@@ -476,9 +478,11 @@ inline bool InputSocketRef::is_multi_input_socket() const
return bsocket_->flag & SOCK_MULTI_INPUT;
}
/* --------------------------------------------------------------------
* OutputSocketRef inline methods.
*/
/** \} */
/* -------------------------------------------------------------------- */
/** \name #OutputSocketRef Inline Methods
* \{ */
inline Span<const InputSocketRef *> OutputSocketRef::logically_linked_sockets() const
{
@@ -490,9 +494,11 @@ inline Span<const InputSocketRef *> OutputSocketRef::directly_linked_sockets() c
return directly_linked_sockets_.cast<const InputSocketRef *>();
}
/* --------------------------------------------------------------------
* NodeRef inline methods.
*/
/** \} */
/* -------------------------------------------------------------------- */
/** \name #NodeRef Inline Methods
* \{ */
inline const NodeTreeRef &NodeRef::tree() const
{
@@ -629,9 +635,11 @@ template<typename T> inline T *NodeRef::storage() const
return (T *)bnode_->storage;
}
/* --------------------------------------------------------------------
* LinkRef inline methods.
*/
/** \} */
/* -------------------------------------------------------------------- */
/** \name #LinkRef Inline Methods
* \{ */
inline const OutputSocketRef &LinkRef::from() const
{
@@ -653,9 +661,11 @@ inline bool LinkRef::is_muted() const
return blink_->flag & NODE_LINK_MUTED;
}
/* --------------------------------------------------------------------
* InternalLinkRef inline methods.
*/
/** \} */
/* -------------------------------------------------------------------- */
/** \name #InternalLinkRef Inline Methods
* \{ */
inline const InputSocketRef &InternalLinkRef::from() const
{
@@ -672,9 +682,11 @@ inline bNodeLink *InternalLinkRef::blink() const
return blink_;
}
/* --------------------------------------------------------------------
* NodeTreeRef inline methods.
*/
/** \} */
/* -------------------------------------------------------------------- */
/** \name #NodeTreeRef Inline Methods
* \{ */
inline Span<const NodeRef *> NodeTreeRef::nodes() const
{
@@ -722,4 +734,6 @@ inline StringRefNull NodeTreeRef::name() const
return btree_->id.name + 2;
}
/** \} */
} // namespace blender::nodes