[Bf-blender-cvs] [8c172691837] master: Cleanup: use C style doxygen comments
Campbell Barton
noreply at git.blender.org
Sat Sep 12 10:02:41 CEST 2020
Commit: 8c1726918374e1d2d2123e17bae8db5aadde3433
Author: Campbell Barton
Date: Sat Sep 12 16:33:34 2020 +1000
Branches: master
https://developer.blender.org/rB8c1726918374e1d2d2123e17bae8db5aadde3433
Cleanup: use C style doxygen comments
===================================================================
M intern/ghost/intern/GHOST_SystemSDL.h
M intern/ghost/intern/GHOST_WindowX11.h
M intern/memutil/MEM_RefCounted.h
M source/blender/blenkernel/BKE_node.h
M source/blender/compositor/intern/COM_ExecutionGroup.cpp
M source/blender/compositor/intern/COM_NodeGraph.cpp
M source/blender/compositor/intern/COM_WorkScheduler.cpp
M source/blender/compositor/nodes/COM_ImageNode.cpp
M source/blender/compositor/operations/COM_ReadBufferOperation.cpp
M source/blender/ikplugin/intern/iksolver_plugin.c
M source/blender/imbuf/intern/dds/BlockDXT.cpp
M source/blender/imbuf/intern/dds/BlockDXT.h
M source/blender/imbuf/intern/dds/Color.h
M source/blender/imbuf/intern/dds/ColorBlock.cpp
M source/blender/imbuf/intern/dds/ColorBlock.h
M source/blender/imbuf/intern/dds/DirectDrawSurface.h
M source/blender/imbuf/intern/dds/Image.h
===================================================================
diff --git a/intern/ghost/intern/GHOST_SystemSDL.h b/intern/ghost/intern/GHOST_SystemSDL.h
index 57e8d17861d..1c92762ea01 100644
--- a/intern/ghost/intern/GHOST_SystemSDL.h
+++ b/intern/ghost/intern/GHOST_SystemSDL.h
@@ -98,6 +98,6 @@ class GHOST_SystemSDL : public GHOST_System {
void processEvent(SDL_Event *sdl_event);
- /// The vector of windows that need to be updated.
+ /** The vector of windows that need to be updated. */
std::vector<GHOST_WindowSDL *> m_dirty_windows;
};
diff --git a/intern/ghost/intern/GHOST_WindowX11.h b/intern/ghost/intern/GHOST_WindowX11.h
index ef5d1755f1a..a4d17d1add3 100644
--- a/intern/ghost/intern/GHOST_WindowX11.h
+++ b/intern/ghost/intern/GHOST_WindowX11.h
@@ -225,7 +225,7 @@ class GHOST_WindowX11 : public GHOST_Window {
bool canInvertColor);
private:
- /// Force use of public constructor.
+ /* Force use of public constructor. */
GHOST_WindowX11();
diff --git a/intern/memutil/MEM_RefCounted.h b/intern/memutil/MEM_RefCounted.h
index 42e595aadf4..06828fc32c3 100644
--- a/intern/memutil/MEM_RefCounted.h
+++ b/intern/memutil/MEM_RefCounted.h
@@ -76,7 +76,7 @@ class MEM_RefCounted {
}
protected:
- /// The reference count.
+ /** The reference count. */
int m_refCount;
};
diff --git a/source/blender/blenkernel/BKE_node.h b/source/blender/blenkernel/BKE_node.h
index 5e8b371e604..3421aa9e900 100644
--- a/source/blender/blenkernel/BKE_node.h
+++ b/source/blender/blenkernel/BKE_node.h
@@ -254,23 +254,23 @@ typedef struct bNodeType {
* \note Used as a fallback when #bNode.label isn't set.
*/
void (*labelfunc)(struct bNodeTree *ntree, struct bNode *node, char *label, int maxlen);
- /// Optional custom resize handle polling.
+ /** Optional custom resize handle polling. */
int (*resize_area_func)(struct bNode *node, int x, int y);
- /// Optional selection area polling.
+ /** Optional selection area polling. */
int (*select_area_func)(struct bNode *node, int x, int y);
- /// Optional tweak area polling (for grabbing).
+ /** Optional tweak area polling (for grabbing). */
int (*tweak_area_func)(struct bNode *node, int x, int y);
- /// Called when the node is updated in the editor.
+ /** Called when the node is updated in the editor. */
void (*updatefunc)(struct bNodeTree *ntree, struct bNode *node);
- /// Check and update if internal ID data has changed.
+ /** Check and update if internal ID data has changed. */
void (*group_update_func)(struct bNodeTree *ntree, struct bNode *node);
- /// Initialize a new node instance of this type after creation.
+ /** Initialize a new node instance of this type after creation. */
void (*initfunc)(struct bNodeTree *ntree, struct bNode *node);
- /// Free the node instance.
+ /** Free the node instance. */
void (*freefunc)(struct bNode *node);
- /// Make a copy of the node instance.
+ /** Make a copy of the node instance. */
void (*copyfunc)(struct bNodeTree *dest_ntree,
struct bNode *dest_node,
const struct bNode *src_node);
diff --git a/source/blender/compositor/intern/COM_ExecutionGroup.cpp b/source/blender/compositor/intern/COM_ExecutionGroup.cpp
index e5dfee7d0cd..08f794d7eba 100644
--- a/source/blender/compositor/intern/COM_ExecutionGroup.cpp
+++ b/source/blender/compositor/intern/COM_ExecutionGroup.cpp
@@ -198,13 +198,13 @@ void ExecutionGroup::execute(ExecutionSystem *graph)
const bNodeTree *bTree = context.getbNodeTree();
if (this->m_width == 0 || this->m_height == 0) {
return;
- } /// \note Break out... no pixels to calculate.
+ } /** \note Break out... no pixels to calculate. */
if (bTree->test_break && bTree->test_break(bTree->tbh)) {
return;
- } /// \note Early break out for blur and preview nodes.
+ } /** \note Early break out for blur and preview nodes. */
if (this->m_numberOfChunks == 0) {
return;
- } /// \note Early break out.
+ } /** \note Early break out. */
unsigned int chunkNumber;
this->m_executionStartTime = PIL_check_seconds_timer();
diff --git a/source/blender/compositor/intern/COM_NodeGraph.cpp b/source/blender/compositor/intern/COM_NodeGraph.cpp
index 01dd662ad11..fe680f61a90 100644
--- a/source/blender/compositor/intern/COM_NodeGraph.cpp
+++ b/source/blender/compositor/intern/COM_NodeGraph.cpp
@@ -184,7 +184,7 @@ NodeOutput *NodeGraph::find_output(const NodeRange &node_range, bNodeSocket *b_s
void NodeGraph::add_bNodeLink(const NodeRange &node_range, bNodeLink *b_nodelink)
{
- /// \note Ignore invalid links.
+ /** \note Ignore invalid links. */
if (!(b_nodelink->flag & NODE_LINK_VALID)) {
return;
}
diff --git a/source/blender/compositor/intern/COM_WorkScheduler.cpp b/source/blender/compositor/intern/COM_WorkScheduler.cpp
index 06929f0037e..570e1eeba20 100644
--- a/source/blender/compositor/intern/COM_WorkScheduler.cpp
+++ b/source/blender/compositor/intern/COM_WorkScheduler.cpp
@@ -44,26 +44,26 @@
# error COM_CURRENT_THREADING_MODEL No threading model selected
#endif
-/// \brief list of all CPUDevices. for every hardware thread an instance of CPUDevice is created
+/** \brief list of all CPUDevices. for every hardware thread an instance of CPUDevice is created */
static vector<CPUDevice *> g_cpudevices;
static ThreadLocal(CPUDevice *) g_thread_device;
#if COM_CURRENT_THREADING_MODEL == COM_TM_QUEUE
-/// \brief list of all thread for every CPUDevice in cpudevices a thread exists
+/** \brief list of all thread for every CPUDevice in cpudevices a thread exists. */
static ListBase g_cputhreads;
static bool g_cpuInitialized = false;
-/// \brief all scheduled work for the cpu
+/** \brief all scheduled work for the cpu */
static ThreadQueue *g_cpuqueue;
static ThreadQueue *g_gpuqueue;
# ifdef COM_OPENCL_ENABLED
static cl_context g_context;
static cl_program g_program;
-/// \brief list of all OpenCLDevices. for every OpenCL GPU device an instance of OpenCLDevice is
-/// created
+/** \brief list of all OpenCLDevices. for every OpenCL GPU device an instance of OpenCLDevice is
+ * created. */
static vector<OpenCLDevice *> g_gpudevices;
-/// \brief list of all thread for every GPUDevice in cpudevices a thread exists
+/** \brief list of all thread for every GPUDevice in cpudevices a thread exists. */
static ListBase g_gputhreads;
-/// \brief all scheduled work for the gpu
+/** \brief all scheduled work for the GPU. */
static bool g_openclActive = false;
static bool g_openclInitialized = false;
# endif
diff --git a/source/blender/compositor/nodes/COM_ImageNode.cpp b/source/blender/compositor/nodes/COM_ImageNode.cpp
index 3dbd3773247..c178722a23f 100644
--- a/source/blender/compositor/nodes/COM_ImageNode.cpp
+++ b/source/blender/compositor/nodes/COM_ImageNode.cpp
@@ -72,7 +72,7 @@ NodeOperation *ImageNode::doMultilayerCheck(NodeConverter &converter,
void ImageNode::convertToOperations(NodeConverter &converter,
const CompositorContext &context) const
{
- /// Image output
+ /** Image output */
NodeOutput *outputImage = this->getOutputSocket(0);
bNode *editorNode = this->getbNode();
Image *image = (Image *)editorNode->id;
diff --git a/source/blender/compositor/operations/COM_ReadBufferOperation.cpp b/source/blender/compositor/operations/COM_ReadBufferOperation.cpp
index 70aaab560cd..99cc9f5dd01 100644
--- a/source/blender/compositor/operations/COM_ReadBufferOperation.cpp
+++ b/source/blender/compositor/operations/COM_ReadBufferOperation.cpp
@@ -41,7 +41,7 @@ void ReadBufferOperation::determineResolution(unsigned int resolution[2],
operation->determineResolution(resolution, preferredResolution);
operation->setResolution(resolution);
- /// \todo: may not occur!, but does with blur node
+ /** \todo: may not occur!, but does with blur node */
if (this->m_memoryProxy->getExecutor()) {
this->m_memoryProxy->getExecutor()->setResolution(resolution);
}
diff --git a/source/blender/ikplugin/intern/iksolver_plugin.c b/source/blender/ikplugin/intern/iksolver_plugin.c
index ba096653e0f..c7d8a8b3723 100644
--- a/source/blender/ikplugin/intern/iksolver_plugin.c
+++ b/source/blender/ikplugin/intern/iksolver_plugin.c
@@ -583,8 +583,8 @@ static void free_posetree(PoseTree *tree)
MEM_freeN(tree);
}
-///----------------------------------------
-/// Plugin API for legacy iksolver
+/* ------------------------------
+ * Plugin API for legacy iksolver */
void iksolver_initialize_tree(struct Depsgraph *UNUSED(depsgraph),
struct Scene *UNUSED(scene),
diff --git a/source/blender/imbuf/intern/dds/BlockDXT.cpp b/source/blender/imbuf/intern/dds/BlockDXT.cpp
index 1fbe7b46963..8978b823e2a 100644
--- a/source/blender/imbuf/intern/dds/BlockDXT.cpp
+++ b/source/blender/imbuf/intern/dds/BlockDXT.cpp
@@ -247,14 +247,14 @@ void BlockDXT1::setIndices(const int *idx)
}
}
-/// Flip DXT1 block vertically.
+/** Flip DXT1 block vertically. */
inline void BlockDXT1::flip4()
{
swap(row[0], row[3]);
swap(row[1], row[2]);
}
-/// Flip half DXT1 block vertically.
+/** Flip half DXT1 block vertically. */
inline void BlockDXT1::flip2()
{
swap(row[0], row[1]);
@@ -299,27 +299,27 @@ void AlphaBlockDXT3::decodeBlock(ColorBlock *block) const
block->color(0xF).a = (alphaF << 4) | alphaF;
}
-/// Flip DXT3 alpha block vertically.
+/** Flip DXT3 alpha block vertically. */
void AlphaBlockDXT3::flip4()
{
swap(row[0], row[3]);
swap(row[1], row[2]);
}
-/// Flip half DXT3 alpha block vertically.
+/** Flip half DXT3 alpha block vertically. */
void AlphaBlockDXT3::flip2()
{
swap(row[0], row[1]);
}
-/// Flip DXT3 block vertically.
+/** Flip DXT3 block vertically. */
void BlockDXT3::flip4()
{
alpha.flip4();
color.flip4();
}
-/// Flip half DXT3 block vertically.
+/** Flip half DXT3 block vertically. */
void BlockDXT3::flip2()
{
alpha.flip2();
@@ -458,21 +458,21 @@ void BlockDXT5::decodeBlockNV5x(ColorBlock *block) const
alpha.decodeBlock(block);
}
-/// Flip DXT5 block vertically.
+/** Flip DXT5 block vertically. */
void BlockDXT5::flip4()
{
alpha.flip4();
color.flip4();
}
-/// Flip half DXT5 bl
@@ Diff output truncated at 10240 characters. @@
More information about the Bf-blender-cvs
mailing list