[Bf-blender-cvs] [44d4a61ed03] master: Cleanup: replace doxy @ with backslash
Campbell Barton
noreply at git.blender.org
Wed Sep 5 06:51:21 CEST 2018
Commit: 44d4a61ed03ac6fc51485ea5621f45098817bcee
Author: Campbell Barton
Date: Wed Sep 5 14:56:29 2018 +1000
Branches: master
https://developer.blender.org/rB44d4a61ed03ac6fc51485ea5621f45098817bcee
Cleanup: replace doxy @ with backslash
The rest of Blender uses backslashes.
===================================================================
M source/blender/compositor/COM_compositor.h
M source/blender/compositor/COM_defines.h
M source/blender/compositor/intern/COM_CPUDevice.h
M source/blender/compositor/intern/COM_CompositorContext.h
M source/blender/compositor/intern/COM_Converter.h
M source/blender/compositor/intern/COM_Device.h
M source/blender/compositor/intern/COM_ExecutionGroup.cpp
M source/blender/compositor/intern/COM_ExecutionGroup.h
M source/blender/compositor/intern/COM_ExecutionSystem.h
M source/blender/compositor/intern/COM_MemoryBuffer.h
M source/blender/compositor/intern/COM_MemoryProxy.h
M source/blender/compositor/intern/COM_Node.h
M source/blender/compositor/intern/COM_NodeGraph.cpp
M source/blender/compositor/intern/COM_NodeOperation.h
M source/blender/compositor/intern/COM_OpenCLDevice.h
M source/blender/compositor/intern/COM_SocketReader.h
M source/blender/compositor/intern/COM_WorkPackage.h
M source/blender/compositor/intern/COM_WorkScheduler.cpp
M source/blender/compositor/intern/COM_WorkScheduler.h
M source/blender/compositor/nodes/COM_AlphaOverNode.h
M source/blender/compositor/nodes/COM_BilateralBlurNode.h
M source/blender/compositor/nodes/COM_BlurNode.h
M source/blender/compositor/nodes/COM_BokehBlurNode.h
M source/blender/compositor/nodes/COM_BokehImageNode.h
M source/blender/compositor/nodes/COM_BoxMaskNode.h
M source/blender/compositor/nodes/COM_BrightnessNode.h
M source/blender/compositor/nodes/COM_ChannelMatteNode.h
M source/blender/compositor/nodes/COM_ChromaMatteNode.h
M source/blender/compositor/nodes/COM_ColorBalanceNode.h
M source/blender/compositor/nodes/COM_ColorCorrectionNode.h
M source/blender/compositor/nodes/COM_ColorCurveNode.h
M source/blender/compositor/nodes/COM_ColorMatteNode.h
M source/blender/compositor/nodes/COM_ColorNode.h
M source/blender/compositor/nodes/COM_ColorRampNode.h
M source/blender/compositor/nodes/COM_ColorSpillNode.h
M source/blender/compositor/nodes/COM_ColorToBWNode.h
M source/blender/compositor/nodes/COM_CompositorNode.h
M source/blender/compositor/nodes/COM_ConvertAlphaNode.h
M source/blender/compositor/nodes/COM_CornerPinNode.h
M source/blender/compositor/nodes/COM_CropNode.h
M source/blender/compositor/nodes/COM_CryptomatteNode.h
M source/blender/compositor/nodes/COM_DefocusNode.h
M source/blender/compositor/nodes/COM_DespeckleNode.h
M source/blender/compositor/nodes/COM_DifferenceMatteNode.h
M source/blender/compositor/nodes/COM_DilateErodeNode.h
M source/blender/compositor/nodes/COM_DirectionalBlurNode.h
M source/blender/compositor/nodes/COM_DisplaceNode.h
M source/blender/compositor/nodes/COM_DistanceMatteNode.h
M source/blender/compositor/nodes/COM_DoubleEdgeMaskNode.h
M source/blender/compositor/nodes/COM_EllipseMaskNode.h
M source/blender/compositor/nodes/COM_FilterNode.h
M source/blender/compositor/nodes/COM_FlipNode.cpp
M source/blender/compositor/nodes/COM_FlipNode.h
M source/blender/compositor/nodes/COM_GammaNode.h
M source/blender/compositor/nodes/COM_GlareNode.h
M source/blender/compositor/nodes/COM_HueSaturationValueCorrectNode.h
M source/blender/compositor/nodes/COM_HueSaturationValueNode.h
M source/blender/compositor/nodes/COM_IDMaskNode.h
M source/blender/compositor/nodes/COM_ImageNode.h
M source/blender/compositor/nodes/COM_InpaintNode.h
M source/blender/compositor/nodes/COM_InvertNode.h
M source/blender/compositor/nodes/COM_KeyingNode.h
M source/blender/compositor/nodes/COM_KeyingScreenNode.h
M source/blender/compositor/nodes/COM_LensDistortionNode.h
M source/blender/compositor/nodes/COM_LuminanceMatteNode.h
M source/blender/compositor/nodes/COM_MapRangeNode.h
M source/blender/compositor/nodes/COM_MapUVNode.h
M source/blender/compositor/nodes/COM_MapValueNode.h
M source/blender/compositor/nodes/COM_MaskNode.h
M source/blender/compositor/nodes/COM_MathNode.h
M source/blender/compositor/nodes/COM_MixNode.h
M source/blender/compositor/nodes/COM_MovieClipNode.h
M source/blender/compositor/nodes/COM_MovieDistortionNode.h
M source/blender/compositor/nodes/COM_NormalNode.h
M source/blender/compositor/nodes/COM_NormalizeNode.h
M source/blender/compositor/nodes/COM_OutputFileNode.h
M source/blender/compositor/nodes/COM_PixelateNode.h
M source/blender/compositor/nodes/COM_PlaneTrackDeformNode.h
M source/blender/compositor/nodes/COM_RenderLayersNode.h
M source/blender/compositor/nodes/COM_RotateNode.h
M source/blender/compositor/nodes/COM_ScaleNode.h
M source/blender/compositor/nodes/COM_SetAlphaNode.h
M source/blender/compositor/nodes/COM_SocketProxyNode.h
M source/blender/compositor/nodes/COM_SplitViewerNode.h
M source/blender/compositor/nodes/COM_Stabilize2dNode.h
M source/blender/compositor/nodes/COM_SunBeamsNode.h
M source/blender/compositor/nodes/COM_SwitchNode.h
M source/blender/compositor/nodes/COM_SwitchViewNode.h
M source/blender/compositor/nodes/COM_TextureNode.h
M source/blender/compositor/nodes/COM_TimeNode.h
M source/blender/compositor/nodes/COM_TonemapNode.h
M source/blender/compositor/nodes/COM_TrackPositionNode.h
M source/blender/compositor/nodes/COM_TransformNode.h
M source/blender/compositor/nodes/COM_TranslateNode.h
M source/blender/compositor/nodes/COM_ValueNode.h
M source/blender/compositor/nodes/COM_VectorBlurNode.h
M source/blender/compositor/nodes/COM_VectorCurveNode.h
M source/blender/compositor/nodes/COM_ViewLevelsNode.h
M source/blender/compositor/nodes/COM_ViewerNode.h
M source/blender/compositor/nodes/COM_ZCombineNode.h
M source/blender/compositor/operations/COM_AntiAliasOperation.h
M source/blender/compositor/operations/COM_BokehImageOperation.h
M source/blender/compositor/operations/COM_CalculateMeanOperation.h
M source/blender/compositor/operations/COM_CalculateStandardDeviationOperation.h
M source/blender/compositor/operations/COM_CompositorOperation.h
M source/blender/compositor/operations/COM_ConvertColorProfileOperation.h
M source/blender/compositor/operations/COM_DotproductOperation.cpp
M source/blender/compositor/operations/COM_GaussianAlphaXBlurOperation.h
M source/blender/compositor/operations/COM_GaussianAlphaYBlurOperation.h
M source/blender/compositor/operations/COM_GaussianXBlurOperation.h
M source/blender/compositor/operations/COM_GaussianYBlurOperation.h
M source/blender/compositor/operations/COM_GlareBaseOperation.h
M source/blender/compositor/operations/COM_GlareThresholdOperation.h
M source/blender/compositor/operations/COM_ImageOperation.h
M source/blender/compositor/operations/COM_MapValueOperation.h
M source/blender/compositor/operations/COM_NormalizeOperation.h
M source/blender/compositor/operations/COM_PixelateOperation.h
M source/blender/compositor/operations/COM_PreviewOperation.h
M source/blender/compositor/operations/COM_ReadBufferOperation.cpp
M source/blender/compositor/operations/COM_RenderLayersProg.h
M source/blender/compositor/operations/COM_TextureOperation.h
M source/blender/compositor/operations/COM_TonemapOperation.h
M source/blender/compositor/operations/COM_VectorBlurOperation.h
M source/blender/compositor/operations/COM_WriteBufferOperation.h
M source/blender/freestyle/intern/stroke/AdvancedStrokeShaders.h
M source/blender/freestyle/intern/stroke/BasicStrokeShaders.h
M source/blender/freestyle/intern/stroke/Stroke.h
M source/gameengine/Ketsji/KX_GameObject.h
M source/gameengine/Rasterizer/RAS_ICanvas.cpp
M source/gameengine/Rasterizer/RAS_ICanvas.h
===================================================================
diff --git a/source/blender/compositor/COM_compositor.h b/source/blender/compositor/COM_compositor.h
index 10b62070978..f9fd0999acc 100644
--- a/source/blender/compositor/COM_compositor.h
+++ b/source/blender/compositor/COM_compositor.h
@@ -31,26 +31,26 @@ extern "C" {
#include "DNA_node_types.h"
/**
- * @defgroup Model The data model of the compositor
- * @defgroup Memory The memory management stuff
- * @defgroup Execution The execution logic
- * @defgroup Conversion Conversion logic
- * @defgroup Node All nodes of the compositor
- * @defgroup Operation All operations of the compositor
+ * \defgroup Model The data model of the compositor
+ * \defgroup Memory The memory management stuff
+ * \defgroup Execution The execution logic
+ * \defgroup Conversion Conversion logic
+ * \defgroup Node All nodes of the compositor
+ * \defgroup Operation All operations of the compositor
*
- * @page Introduction of the Blender Compositor
+ * \page Introduction of the Blender Compositor
*
- * @section bcomp Blender compositor
+ * \section bcomp Blender compositor
* This project redesigns the internals of Blender's compositor. The project has been executed in 2011 by At Mind.
* At Mind is a technology company located in Amsterdam, The Netherlands.
* The project has been crowd-funded. This code has been released under GPL2 to be used in Blender.
*
- * @section goals The goals of the project
+ * \section goals The goals of the project
* the new compositor has 2 goals.
* - Make a faster compositor (speed of calculation)
* - Make the compositor work faster for you (workflow)
*
- * @section speed Faster compositor
+ * \section speed Faster compositor
* The speedup has been done by making better use of the hardware Blenders is working on. The previous compositor only
* used a single threaded model to calculate a node. The only exception to this is the Defocus node.
* Only when it is possible to calculate two full nodes in parallel a second thread was used.
@@ -59,27 +59,27 @@ extern "C" {
* In the new compositor we want to use as much of threads as possible. Even new OpenCL capable GPU-hardware can be
* used for calculation.
*
- * @section workflow Work faster
+ * \section workflow Work faster
* The previous compositor only showed the final image. The compositor could wait a long time before seeing the result
* of his work. The new compositor will work in a way that it will focus on getting information back to the user.
* It will prioritize its work to get earlier user feedback.
*
- * @page memory Memory model
+ * \page memory Memory model
* The main issue is the type of memory model to use. Blender is used by consumers and professionals.
* Ranging from low-end machines to very high-end machines.
* The system should work on high-end machines and on low-end machines.
*
*
- * @page executing Executing
- * @section prepare Prepare execution
+ * \page executing Executing
+ * \section prepare Prepare execution
*
* during the preparation of the execution All ReadBufferOperation will receive an offset.
* This offset is used during execution as an optimization trick
- * Next all operations will be initialized for execution @see NodeOperation.initExecution
- * Next all ExecutionGroup's will be initialized for execution @see ExecutionGroup.initExecution
- * this all is controlled from @see ExecutionSystem.execute
+ * Next all operations will be initialized for execution \see NodeOperation.initExecution
+ * Next all ExecutionGroup's will be initialized for execution \see ExecutionGroup.initExecution
+ * this all is controlled from \see ExecutionSystem.execute
*
- * @section priority Render priority
+ * \section priority Render priority
* Render priority is an priority of an output node. A user has a different need of Render priorities of output nodes
* than during editing.
* for example. the Active ViewerNode has top priority during editing, but during rendering a CompositeNode has.
@@ -88,11 +88,11 @@ extern "C" {
* priority do match.
* When match the ExecutionGroup will be executed (this happens in serial)
*
- * @see ExecutionSystem.execute control of the Render priority
- * @see NodeOperation.getRenderPriority receive the render priority
- * @see ExecutionGroup.execute the main loop to execute a whole ExecutionGroup
+ * \see ExecutionSystem.execute control of the Render priority
+ * \see NodeOperation.getRenderPriority receive the render priority
+ * \see ExecutionGroup.execute the main loop to execute a whole ExecutionGroup
*
- * @section order Chunk order
+ * \section order Chunk order
*
* When a ExecutionGroup is executed, first the order of chunks are determined.
* The settings are stored in the ViewerNode inside the ExecutionGroup. ExecutionGroups that have no viewer-node,
@@ -109,11 +109,11 @@ extern "C" {
* - [@ref ChunkExecutionState.COM_ES_SCHEDULED]: All dependencies are met, chunk is scheduled, but not finished
* - [@ref ChunkExecutionState.COM_ES_EXECUTED]: Chunk is finished
*
- * @see ExecutionGroup.execute
- * @see ViewerOperation.getChunkOrder
- * @see OrderOfChunks
+ * \see ExecutionGroup.execute
+ * \see ViewerOperation.getChunkOrder
+ * \see OrderOfChunks
*
- * @section interest Area of interest
+ * \section interest Area of interest
* An ExecutionGroup can have dependencies to other ExecutionGroup's. Data passing from one ExecutionGroup to another
* one are stored in 'chunks'.
* If not all input chunks are available the chunk execution will not be scheduled.
@@ -206,40 +206,40 @@ extern "C" {
*
* </pre>
*
- * @see ExecutionGroup.execute Execute a complete ExecutionGroup. Halts until finished or breaked by user
- * @see ExecutionGroup.scheduleChunkWhenPossible Tries to schedule a single chunk,
+ * \see ExecutionGroup.execute Execute a complete ExecutionGroup. Halts until finished or breaked by user
+ * \see ExecutionGroup.scheduleChunkWhenPossible Tries to schedule a single chunk,
* checks if all input data is available. Can trigger dependent chunks to be calculated
- * @see ExecutionGroup.scheduleAreaWhenPossible Tries to schedule an area. This can be multiple chunks
+ * \see ExecutionGroup.scheduleAreaWhenPossible Tries to schedule an area. This can be multiple chunks
* (is called from [@ref ExecutionGroup.scheduleChunkWhenPossible])
- * @see ExecutionGroup.scheduleChunk Schedule a chunk on the WorkScheduler
- * @see NodeOperation.determineDependingAreaOfInterest Influence the area of interest of a chunk.
- * @see WriteBufferOperation Operation to write to a MemoryProxy/MemoryBuffer
- * @see ReadBufferOperation Operation to read from a MemoryProxy/MemoryBuffer
- * @see MemoryProxy proxy for information about memory image (a image consist out of multiple chunks)
- * @see MemoryBuffer Allocated memory for a single chunk
- *
- * @section workscheduler WorkScheduler
+ * \see ExecutionGroup.scheduleChunk Schedule a chunk on the WorkScheduler
+ * \see NodeOperation.determineDependingAreaOfInterest Influence the area of interest of a chunk.
+ * \see WriteBufferOperation Operation to write to a MemoryProxy/MemoryBuffer
+ * \see ReadBufferOperation Operation to read from a MemoryProxy/MemoryBuffer
+ * \see MemoryProxy proxy for information about memory image (a image consist out of multiple chunks)
+ * \see MemoryBuffer Allocated memory for a single chunk
+ *
+ * \section workscheduler WorkScheduler
* the WorkScheduler is implemented as a static class. the responsibility of the WorkScheduler is to balance
* WorkPackages to the available and free devices.
* the work-scheduler can work in 2 states. For witching these between the state you need to recompile blender
*
- * @subsection multithread Multi threaded
+ * \subsection multithread Multi threaded
* Default the work-scheduler will place all work as WorkPackage in a queue.
* For every CPUcore a working thread is created. These working threads will ask the WorkScheduler if there is work
* for a specific Device.
* the work-scheduler will find work for the device and the device will be asked to execute the WorkPackage
*
- * @subsection singlethread Single threaded
+ * \subsection singlethread Single threaded
* For debugging reasons the multi-threading can be disabled. This is done by changing the COM_CURRENT_THREADING_MODEL
* to COM_TM_NOTHREAD. When compiling the work-scheduler
* will be changes to support no threading and run everything on the CPU.
*
- * @section devices Devices
+ * \section devices Devices
* A Device within the compositor context is a Hardware component that can used to calculate chunks.
* This chunk is encapsulated in a WorkPackage.
* the WorkScheduler controls the devices and selects the device where a WorkPackage will be calculated.
*
- * @subsection WS_Devices Workscheduler
+ * \subsection WS_Devices Workscheduler
* The WorkScheduler controls all Devices. When initializing the compositor the WorkScheduler selects
* all devices that will be used during compositor.
* There are two types of Devices, CPUDevice and OpenCLDevice.
@@ -251,63 +251,63 @@ extern "C" {
*
* A thread will read the work-list and sends a workpackage to its device.
*
- * @see WorkScheduler.schedule method that is called to schedule a chunk
- * @see Device.execute method called to execute a chunk
+ * \see WorkScheduler.schedule method that is called to schedule a chunk
+ * \see Device.execute method called to execute a chunk
*
- * @subsection CPUDevice CPUDevice
+ * \subsection CPUDevice CPUDevice
* When a CPUDevice gets a WorkPackage the Device will get the inputbuffer that is needed to calculate the chunk.
* Allocation is already done by the ExecutionGroup.
* The outputbuffer of the chunk is being created.
* The OutputOperation of the ExecutionGroup is called to execute the area of the outputbuffer.
*
- * @see ExecutionGroup
- * @see NodeOperation.executeRegion executes a single chunk of a NodeOperation
- * @see CPUDevice.execute
+ * \see ExecutionGroup
+ * \see NodeOperation.executeRegion executes a single chunk of a NodeOperation
+ * \see CPUDevice.execute
*
- * @subsection GPUDevice OpenCLDevice
+ * \subsection GPUDevice OpenCLDevice
*
* To be compl
@@ Diff output truncated at 10240 characters. @@
More information about the Bf-blender-cvs
mailing list