Documentation pass

ManagedFbx.Samples/FbxForm.cs

@@ -9,6 +9,7 @@ public partial class FbxForm : Form
 	public FbxForm()
 	{
 		InitializeComponent();
+		SetTitle("Untitled");
 	}
 
 	public void Add(SceneNode node, TreeNode parentNode)
@@ -104,6 +105,7 @@ private void LoadFile(object sender, EventArgs e)
 			m_scene = Scene.Import(scenePath);
 			uxFbxTree.Nodes.Clear();
 			Add(m_scene.RootNode, null);
+			SetTitle(scenePath);
 		}
 	}
 
@@ -119,6 +121,11 @@ private void SaveFile(object sender, EventArgs e)
 		}
 	}
 
+	private void SetTitle(string filename)
+	{
+		Text = "FbxForm - " + filename;
+	}
+
 	private Scene m_scene;
 }
 

ManagedFbx/Polygon.h

@@ -2,9 +2,15 @@
 
 namespace ManagedFbx
 {
+	/// <summary>
+	/// Represents a polygon.
+	/// </summary>
 	public value struct Polygon
 	{
 	public:
+		/// <summary>
+		/// Gets the array of indices which make up this polygon.
+		/// </summary>
 		property_ri(array<int>^, Indices);
 
 	private:

ManagedFbx/SceneNode.h

@@ -8,20 +8,55 @@ using namespace System::Collections::Generic;
 
 namespace ManagedFbx
 {
+	/// <summary>
+	/// Represents a single node in the FBX scene graph.
+	/// </summary>
 	public ref class SceneNode
 	{
 	public:
+		/// <summary>
+		/// Gets and sets the name of this node.
+		/// </summary>
 		property_rw(string^, Name);
+
+		/// <summary>
+		/// Gets the direct children of this node.
+		/// </summary>
 		property_r(IEnumerable<SceneNode^>^, ChildNodes);
+
+		/// <summary>
+		/// Gets a collection of FBX attributes for this node.
+		/// </summary>
 		property_r(IEnumerable<NodeAttribute^>^, Attributes);
-
+
+		/// <summary>
+		/// Gets and sets the position of this node.
+		/// </summary>
 		property_rw(Vector3, Position);
+
+		/// <summary>
+		/// Gets and sets the rotation of this node.
+		/// </summary>
 		property_rw(Vector3, Rotation);
+
+		/// <summary>
+		/// Gets and sets the scale of this node.
+		/// </summary>
 		property_rw(Vector3, Scale);
 
+		/// <summary>
+		/// Gets the first mesh attribute of this node if it exists, otherwise null.
+		/// </summary>
 		property_r(ManagedFbx::Mesh^, Mesh);
+
+		/// <summary>
+		/// Gets the first light attribute of this node if it exists, otherwise null.
+		/// </summary>
 		property_r(ManagedFbx::Light^, Light);
 
+		/// <summary>
+		/// Adds an existing node as a child of this node.
+		/// </summary>
 		void AddChild(SceneNode ^node);
 
 	internal: