From 7de947c7c08acdc597bc0bd3f67f43e2bafd3760 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Branimir=20Karad=C5=BEi=C4=87?= <branimirkaradzic@gmail.com>
Date: Thu, 4 Aug 2016 08:35:14 -0700
Subject: [PATCH] Updated docs.

---
 include/bgfx/bgfx.h | 47 ++++++++++++++++++++++++++++++++-------------
 1 file changed, 34 insertions(+), 13 deletions(-)

diff --git a/include/bgfx/bgfx.h b/include/bgfx/bgfx.h
index 77005638a..03f360528 100644
--- a/include/bgfx/bgfx.h
+++ b/include/bgfx/bgfx.h
@@ -285,6 +285,7 @@ namespace bgfx
 	///
 	struct OcclusionQueryResult
 	{
+		/// Occlusion query results:
 		enum Enum
 		{
 			Invisible, //!< Query failed test.
@@ -301,6 +302,7 @@ namespace bgfx
 	///
 	struct TopologyConvert
 	{
+		/// Topology conversion functions:
 		enum Enum
 		{
 			TriListFlipWinding,  //!< Flip winding order of triangle list.
@@ -312,23 +314,27 @@ namespace bgfx
 		};
 	};
 
+	/// Topology sort order.
+	///
+	/// @attention C99 equivalent is `bgfx_topology_sort_t`.
 	///
 	struct TopologySort
 	{
+		/// Topology sort order:
 		enum Enum
 		{
-			DirectionFrontToBackMin,
-			DirectionFrontToBackAvg,
-			DirectionFrontToBackMax,
-			DirectionBackToFrontMin,
-			DirectionBackToFrontAvg,
-			DirectionBackToFrontMax,
-			DistanceFrontToBackMin,
-			DistanceFrontToBackAvg,
-			DistanceFrontToBackMax,
-			DistanceBackToFrontMin,
-			DistanceBackToFrontAvg,
-			DistanceBackToFrontMax,
+			DirectionFrontToBackMin, //!<
+			DirectionFrontToBackAvg, //!<
+			DirectionFrontToBackMax, //!<
+			DirectionBackToFrontMin, //!<
+			DirectionBackToFrontAvg, //!<
+			DirectionBackToFrontMax, //!<
+			DistanceFrontToBackMin,  //!<
+			DistanceFrontToBackAvg,  //!<
+			DistanceFrontToBackMax,  //!<
+			DistanceBackToFrontMin,  //!<
+			DistanceBackToFrontAvg,  //!<
+			DistanceBackToFrontMax,  //!<
 
 			Count
 		};
@@ -835,7 +841,7 @@ namespace bgfx
 	/// @param[in] _dstSize Destination index buffer in bytes. It must be
 	///    large enough to contain output indices. If destination size is
 	///    insufficient index buffer will be truncated.
-	/// @param[in] _indices Source indices.
+	/// @param[in]_indices Source indices.
 	/// @param[in] _numIndices Number of input indices.
 	/// @param[in] _index32 Set to `true` if input indices are 32-bit.
 	///
@@ -854,6 +860,21 @@ namespace bgfx
 
 	/// Sort indices.
 	///
+	/// @param[in] _sort Sort order, see `TopologySort::Enum`.
+	/// @param[in] _dst Destination index buffer.
+	/// @param[in] _dstSize Destination index buffer in bytes. It must be
+	///    large enough to contain output indices. If destination size is
+	///    insufficient index buffer will be truncated.
+	/// @param[in] _dir Direction (vector must be normalized).
+	/// @param[in] _pos Position.
+	/// @param[in] _vertices Pointer to first vertex represented as
+	///    float x, y, z. Must contain at least number of vertices
+	///    referencende by index buffer.
+	/// @param[in] _stride Vertex stride.
+	/// @param[in] _indices Source indices.
+	/// @param[in] _numIndices Number of input indices.
+	/// @param[in] _index32 Set to `true` if input indices are 32-bit.
+	///
 	/// @attention C99 equivalent is `bgfx_topology_sort_tri_list`.
 	///
 	void topologySortTriList(