فهرست منبع

Fixing documentation errors

BearishSun 9 سال پیش
والد
کامیت
2c4d19339c

+ 5 - 2
Source/BansheeCore/Include/BsGpuParams.h

@@ -244,12 +244,15 @@ namespace BansheeEngine
 		static SPtr<GpuParamsCore> create(const SPtr<GraphicsPipelineStateCore>& pipelineState,
 										  GpuDeviceFlags deviceMask = GDF_DEFAULT);
 
-		/** @copydoc GpuParams::create(const SPtr<ComputePipelineStateCore>&) */
+		/** 
+		 * @copydoc GpuParams::create(const SPtr<ComputePipelineState>&) 
+		 * @param[in]	deviceMask		Mask that determines on which GPU devices should the buffer be created on.
+		 */
 		static SPtr<GpuParamsCore> create(const SPtr<ComputePipelineStateCore>& pipelineState,
 										  GpuDeviceFlags deviceMask = GDF_DEFAULT);
 
 		/** 
-		 * @copydoc GpuParams::create(const SPtr<ComputePipelineStateCore>&)
+		 * @copydoc GpuParams::create(const SPtr<GpuPipelineParamInfo>&)
 		 * @param[in]	deviceMask		Mask that determines on which GPU devices should the buffer be created on.
 		 */
 		static SPtr<GpuParamsCore> create(const SPtr<GpuPipelineParamInfoCore>& paramInfo,

+ 5 - 1
Source/BansheeCore/Include/BsGpuPipelineParamInfo.h

@@ -110,7 +110,11 @@ namespace BansheeEngine
 		 */
 		SPtr<GpuPipelineParamInfoCore> getCore() const;
 
-		/** Constructs the object using the provided GPU parameter descriptors. */
+		/** 
+		 * Constructs the object using the provided GPU parameter descriptors. 
+		 * 
+		 * @param[in]	desc	Object containing parameter descriptions for individual GPU program stages.
+		 */
 		static SPtr<GpuPipelineParamInfo> create(const GPU_PIPELINE_PARAMS_DESC& desc);
 
 	private:

+ 2 - 2
Source/BansheeCore/Include/BsGpuPipelineState.h

@@ -227,7 +227,7 @@ namespace BansheeEngine
 		GraphicsPipelineStateCore(const PIPELINE_STATE_CORE_DESC& desc, GpuDeviceFlags deviceMask);
 		virtual ~GraphicsPipelineStateCore() { }
 
-		/** @copydoc RenderStateManager::createGraphicsPipelineState */
+		/** @copydoc RenderStateCoreManager::createGraphicsPipelineState */
 		static SPtr<GraphicsPipelineStateCore> create(const PIPELINE_STATE_CORE_DESC& desc, 
 			GpuDeviceFlags deviceMask = GDF_DEFAULT);
 	};
@@ -239,7 +239,7 @@ namespace BansheeEngine
 		ComputePipelineStateCore(const SPtr<GpuProgramCore>& program, GpuDeviceFlags deviceMask);
 		virtual ~ComputePipelineStateCore() { }
 
-		/** @copydoc RenderStateManager::createComputePipelineState */
+		/** @copydoc RenderStateCoreManager::createComputePipelineState */
 		static SPtr<ComputePipelineStateCore> create(const SPtr<GpuProgramCore>& program,
 			GpuDeviceFlags deviceMask = GDF_DEFAULT);
 	};

+ 1 - 0
Source/BansheeCore/Include/BsHardwareBuffer.h

@@ -160,6 +160,7 @@ namespace BansheeEngine
 		/**
 		 * Copy data from the provided buffer into this buffer. If buffers are not the same size, smaller size will be used.
 		 * 
+		 * @param[in]	srcBuffer	Hardware buffer to copy from.
 		 * @param[in]	queueIdx	Device queue to perform any read/write operations on. Using a non-default queue index
 		 *							allows the GPU to perform write or read operations while executing rendering or compute
 		 *							operations on the same time.

+ 1 - 1
Source/BansheeCore/Include/BsHardwareBufferManager.h

@@ -124,7 +124,7 @@ namespace BansheeEngine
 		 */
 		SPtr<GpuBufferCore> createGpuBuffer(const GPU_BUFFER_DESC& desc, GpuDeviceFlags deviceMask = GDF_DEFAULT);
 
-		/** @copydoc GpuParamsCore::create(const SPtr<GpuPipelineParamInfoCore>&) */
+		/** @copydoc GpuParamsCore::create(const SPtr<GpuPipelineParamInfoCore>&, GpuDeviceFlags) */
 		SPtr<GpuParamsCore> createGpuParams(const SPtr<GpuPipelineParamInfoCore>& paramInfo,
 											GpuDeviceFlags deviceMask = GDF_DEFAULT);
 	protected:

+ 15 - 3
Source/BansheeCore/Include/BsRenderStateManager.h

@@ -21,7 +21,11 @@ namespace BansheeEngine
 	class BS_CORE_EXPORT RenderStateManager : public Module <RenderStateManager>
 	{
 	public:
-		/**	Creates and initializes a new SamplerState. */
+		/**	
+		 * Creates and initializes a new SamplerState. 
+		 * 
+		 * @param[in]	desc	Object describing the sampler state to create.
+		 */
 		SPtr<SamplerState> createSamplerState(const SAMPLER_STATE_DESC& desc) const;
 
 		/** Creates and initializes a new DepthStencilState. */
@@ -33,10 +37,18 @@ namespace BansheeEngine
 		/**	Creates and initializes a new BlendState. */
 		SPtr<BlendState> createBlendState(const BLEND_STATE_DESC& desc) const;
 
-		/**	Creates and initializes a new GraphicsPipelineState. */
+		/**	
+		 * Creates and initializes a new GraphicsPipelineState. 
+		 *
+		 * @param[in]	desc	Object describing the pipeline to create.
+		 */
 		SPtr<GraphicsPipelineState> createGraphicsPipelineState(const PIPELINE_STATE_DESC& desc) const;
 
-		/**	Creates and initializes a new ComputePipelineState. */
+		/**	
+		 * Creates and initializes a new ComputePipelineState. 
+		 *
+		 * @param[in]	program		Compute GPU program to be executed by the pipeline.
+		 */
 		SPtr<ComputePipelineState> createComputePipelineState(const SPtr<GpuProgram>& program) const;
 
 		/** Creates an uninitialized sampler state. Requires manual initialization after creation. */

+ 1 - 1
Source/BansheeD3D11RenderAPI/Include/BsD3D11GpuBuffer.h

@@ -29,7 +29,7 @@ namespace BansheeEngine
 		void readData(UINT32 offset, UINT32 length, void* dest, UINT32 deviceIdx = 0, UINT32 queueIdx = 0) override;
 
 		/** @copydoc GpuBufferCore::writeData */
-        void writeData(UINT32 offset, UINT32 length, const void* pSource,
+        void writeData(UINT32 offset, UINT32 length, const void* source,
 			BufferWriteType writeFlags = BWT_NORMAL, UINT32 queueIdx = 0) override;
 
 		/** @copydoc GpuBufferCore::copyData */

+ 4 - 1
Source/BansheeD3D11RenderAPI/Include/BsD3D11GpuBufferView.h

@@ -47,7 +47,10 @@ namespace BansheeEngine
 		GpuBufferView();
 		virtual ~GpuBufferView();
 
-		/** @copydoc GpuBufferView::initialize */
+		/** 
+		 * Initializes a new buffer view for the specified buffer. Descriptor structure defines which portion of the buffer,
+		 * and how will its contents be represented by the view.
+		 */
 		void initialize(const SPtr<D3D11GpuBufferCore>& buffer, GPU_BUFFER_VIEW_DESC& desc);
 
 		/** Returns a descriptor structure used for creating the view. */

+ 2 - 2
Source/BansheeD3D11RenderAPI/Include/BsD3D11RenderAPI.h

@@ -135,10 +135,10 @@ namespace BansheeEngine
 	protected:
 		friend class D3D11RenderAPIFactory;
 
-		/** @copydoc RenderAPICore::initializePrepare */
+		/** @copydoc RenderAPICore::initialize */
 		void initialize() override;
 
-		/** @copydoc RenderAPICore::initializeFinalize */
+		/** @copydoc RenderAPICore::initializeWithWindow */
 		void initializeWithWindow(const SPtr<RenderWindowCore>& primaryWindow) override;
 
 		/** @copydoc RenderAPICore::destroyCore */

+ 1 - 1
Source/BansheeGLRenderAPI/Include/BsGLGpuBuffer.h

@@ -28,7 +28,7 @@ namespace BansheeEngine
         void readData(UINT32 offset, UINT32 length, void* dest, UINT32 deviceIdx = 0, UINT32 queueIdx = 0) override;
 
 		/** @copydoc GpuBufferCore::writeData */
-        void writeData(UINT32 offset, UINT32 length, const void* pSource,
+        void writeData(UINT32 offset, UINT32 length, const void* source,
 				BufferWriteType writeFlags = BWT_NORMAL, UINT32 queueIdx = 0) override;
 
 		/** @copydoc GpuBufferCore::copyData */

+ 2 - 2
Source/BansheeGLRenderAPI/Include/BsGLRenderAPI.h

@@ -126,10 +126,10 @@ namespace BansheeEngine
 		GLSupport* getGLSupport() const { return mGLSupport; }
 
 	protected:
-		/** @copydoc RenderAPICore::initializePrepare */
+		/** @copydoc RenderAPICore::initialize */
 		void initialize() override;
 
-		/** @copydoc RenderAPICore::initializeFinalize */
+		/** @copydoc RenderAPICore::initializeWithWindow */
 		void initializeWithWindow(const SPtr<RenderWindowCore>& primaryWindow) override;
 
 		/** @copydoc RenderAPICore::destroyCore */