Browse Source

Updating docs

BearishSun 9 years ago
parent
commit
2efdfb1800

+ 16 - 1
Source/BansheeCore/Include/BsCommandBuffer.h

@@ -20,7 +20,22 @@ namespace BansheeEngine
 	class BS_CORE_EXPORT CommandBuffer
 	{
 	public:
-		/** @copydoc CommandBufferManager::create */
+		/**
+		 * Creates a new CommandBuffer.
+		 * 
+		 * @param[in]	type		Determines what type of commands can be added to the command buffer.
+		 * @param[in]	deviceIdx	Index of the GPU the command buffer will be used to queue commands on. 0 is always
+		 *							the primary available GPU.
+		 * @param[in]	syncMask	Determines how is concurrency handled between multiple command buffers on the same 
+		 *							device. If buffers don't share the same bits in the sync mask they are allowed to
+		 *							execute concurrently on the GPU, however it is up to the user to ensure that they
+		 *							do not contain any resources depended on each other. Leave on default to ensure
+		 *							no concurrency is possible (safest).
+		 * @param[in]	secondary	If true the command buffer will not be allowed to execute on its own, but it can
+		 *							be appended to a primary command buffer. 
+		 * @return					New CommandBuffer instance.
+		 * 
+		 */
 		static SPtr<CommandBuffer> create(CommandBufferType type, UINT32 deviceIdx = 0, UINT32 syncMask = 0xFFFFFFFF, 
 			bool secondary = false);
 

+ 1 - 16
Source/BansheeCore/Include/BsCommandBufferManager.h

@@ -19,22 +19,7 @@ namespace BansheeEngine
 	class BS_CORE_EXPORT CommandBufferManager : public Module<CommandBufferManager>
 	{
 	public:
-		/**
-		 * Creates a new CommandBuffer.
-		 * 
-		 * @param[in]	type		Determines what type of commands can be added to the command buffer.
-		 * @param[in]	deviceIdx	Index of the GPU the command buffer will be used to queue commands on. 0 is always
-		 *							the primary available GPU.
-		 * @param[in]	syncMask	Determines how is concurrency handled between multiple command buffers on the same 
-		 *							device. If buffers don't share the same bits in the sync mask they are allowed to
-		 *							execute concurrently on the GPU, however it is up to the user to ensure that they
-		 *							do not contain any resources depended on each other. Leave on default to ensure
-		 *							no concurrency is possible (safest).
-		 * @param[in]	secondary	If true the command buffer will not be allowed to execute on its own, but it can
-		 *							be appended to a primary command buffer. 
-		 * @return					New CommandBuffer instance.
-		 * 
-		 */
+		/** @copydoc CommandBuffer::create */
 		virtual SPtr<CommandBuffer> create(CommandBufferType type, UINT32 deviceIdx = 0, UINT32 syncMask = 0xFFFFFFFF, 
 			bool secondary = false) = 0;
 	};