Ver código fonte

Fixing some documentation errors

BearishSun 8 anos atrás
pai
commit
0c1be4aac3

+ 7 - 1
Source/BansheeCore/Include/BsMorphShapes.h

@@ -26,8 +26,14 @@ namespace bs
 	};
 	};
 
 
 	/** 
 	/** 
+	 * @native
 	 * A set of vertices representing a single shape in a morph target animation. Vertices are represented as a difference
 	 * A set of vertices representing a single shape in a morph target animation. Vertices are represented as a difference
-	 * between base and target shape.
+	 * between base and target shape. 
+	 * @endnative
+	 * @script
+	 * Name and weight of a single shape in a morph target animation. Each shape internally represents a set of vertices
+	 * that describe the morph shape.
+	 * @endscript
 	 */
 	 */
 	class BS_CORE_EXPORT BS_SCRIPT_EXPORT(m:Animation) MorphShape : public IReflectable
 	class BS_CORE_EXPORT BS_SCRIPT_EXPORT(m:Animation) MorphShape : public IReflectable
 	{
 	{

+ 5 - 0
Source/BansheeCore/Include/BsSkeleton.h

@@ -103,8 +103,13 @@ namespace bs
 	};
 	};
 
 
 	/** 
 	/** 
+	 * @native
 	 * Contains information about bones required for skeletal animation. Allows caller to evaluate a set of animation
 	 * Contains information about bones required for skeletal animation. Allows caller to evaluate a set of animation
 	 * clips at a specific time and output the relevant skeleton pose.
 	 * clips at a specific time and output the relevant skeleton pose.
+	 * @endnative
+	 * @script
+	 * Contains information about bones required for skeletal animation.
+	 * @endscript
 	 */
 	 */
 	class BS_CORE_EXPORT BS_SCRIPT_EXPORT(m:Animation) Skeleton : public IReflectable // Note: Must be immutable in order to be usable on multiple threads
 	class BS_CORE_EXPORT BS_SCRIPT_EXPORT(m:Animation) Skeleton : public IReflectable // Note: Must be immutable in order to be usable on multiple threads
 	{
 	{

+ 2 - 2
Source/RenderBeast/Include/BsPostProcessing.h

@@ -442,7 +442,7 @@ namespace bs { namespace ct
 		 * @param[in]	far			Input texture containing filtered (blurred) values for the unfocused background area.
 		 * @param[in]	far			Input texture containing filtered (blurred) values for the unfocused background area.
 		 *							Can be null if no far plane needs to be blended.
 		 *							Can be null if no far plane needs to be blended.
 		 * @param[in]	depth		Input depth buffer texture that will be used for determining pixel depth.
 		 * @param[in]	depth		Input depth buffer texture that will be used for determining pixel depth.
-		 * @param[in}	output		Texture to output the results to.
+		 * @param[in]	output		Texture to output the results to.
 		 * @param[in]	view		View through which the depth of field effect is viewed.
 		 * @param[in]	view		View through which the depth of field effect is viewed.
 		 * @param[in]	settings	Settings used to control depth of field rendering. 
 		 * @param[in]	settings	Settings used to control depth of field rendering. 
 		 */
 		 */
@@ -488,7 +488,7 @@ namespace bs { namespace ct
 		 * 
 		 * 
 		 * @param[in]	sceneColor	Input texture containing scene color.
 		 * @param[in]	sceneColor	Input texture containing scene color.
 		 * @param[in]	sceneDepth	Input depth buffer texture that will be used for determining pixel depth.
 		 * @param[in]	sceneDepth	Input depth buffer texture that will be used for determining pixel depth.
-		 * @param[in}	output		Texture to output the results to.
+		 * @param[in]	output		Texture to output the results to.
 		 * @param[in]	view		View through which the depth of field effect is viewed.
 		 * @param[in]	view		View through which the depth of field effect is viewed.
 		 * @param[in]	settings	Settings used to control depth of field rendering. 
 		 * @param[in]	settings	Settings used to control depth of field rendering. 
 		 */
 		 */

+ 2 - 0
Source/SBansheeEngine/Include/BsMeshDataEx.h

@@ -11,6 +11,7 @@ namespace bs
 	/** @addtogroup ScriptInteropEngine
 	/** @addtogroup ScriptInteropEngine
 	 *  @{
 	 *  @{
 	 */
 	 */
+	/** @cond SCRIPT_EXTENSIONS */
 
 
 	/** Extension class for RendererMeshData, for adding additional functionality for the script version of the class. */
 	/** Extension class for RendererMeshData, for adding additional functionality for the script version of the class. */
 	class BS_SCRIPT_EXPORT(e:RendererMeshData) MeshDataEx
 	class BS_SCRIPT_EXPORT(e:RendererMeshData) MeshDataEx
@@ -83,5 +84,6 @@ namespace bs
 		static int getIndexCount(const SPtr<RendererMeshData>& thisPtr);
 		static int getIndexCount(const SPtr<RendererMeshData>& thisPtr);
 	};
 	};
 
 
+	/** @endcond */
 	/** @} */
 	/** @} */
 }
 }

+ 2 - 0
Source/SBansheeEngine/Include/BsMeshEx.h

@@ -12,6 +12,7 @@ namespace bs
 	/** @addtogroup ScriptInteropEngine
 	/** @addtogroup ScriptInteropEngine
 	 *  @{
 	 *  @{
 	 */
 	 */
+	/** @cond SCRIPT_EXTENSIONS */
 
 
 	/** Extension class for Mesh, for adding additional functionality for the script version of the class. */
 	/** Extension class for Mesh, for adding additional functionality for the script version of the class. */
 	class BS_SCRIPT_EXPORT(e:Mesh) MeshEx
 	class BS_SCRIPT_EXPORT(e:Mesh) MeshEx
@@ -101,5 +102,6 @@ namespace bs
 		static void setMeshData(const HMesh& thisPtr, const SPtr<RendererMeshData>& value);
 		static void setMeshData(const HMesh& thisPtr, const SPtr<RendererMeshData>& value);
 	};
 	};
 
 
+	/** @endcond */
 	/** @} */
 	/** @} */
 }
 }

+ 2 - 0
Source/SBansheeEngine/Include/BsSkeletonEx.h

@@ -11,6 +11,7 @@ namespace bs
 	/** @addtogroup ScriptInteropEngine
 	/** @addtogroup ScriptInteropEngine
 	 *  @{
 	 *  @{
 	 */
 	 */
+	/** @cond SCRIPT_EXTENSIONS */
 
 
 	/** Contains internal information about a single bone in a Skeleton. */
 	/** Contains internal information about a single bone in a Skeleton. */
 	struct BS_SCRIPT_EXPORT(n:BoneInfo,pl:true) SkeletonBoneInfoEx
 	struct BS_SCRIPT_EXPORT(n:BoneInfo,pl:true) SkeletonBoneInfoEx
@@ -38,5 +39,6 @@ namespace bs
 		static SkeletonBoneInfoEx getBoneInfo(const SPtr<Skeleton>& thisPtr, int boneIdx);
 		static SkeletonBoneInfoEx getBoneInfo(const SPtr<Skeleton>& thisPtr, int boneIdx);
 	};
 	};
 
 
+	/** @endcond */
 	/** @} */
 	/** @} */
 }
 }