# HG changeset patch
# User IBBoard <dev@ibboard.co.uk>
# Date 1313328852 -3600
# Node ID 27b6aa1e98e84dc120ff72cb595ff5e0a4cffe83
# Parent  0f88d32b22cc0349b032718ee830a99a999b9f44
Re #12: Document classes and methods
 * Document the Constants
(Also - test new Hg repo and hooks)

diff -r 0f88d32b22cc -r 27b6aa1e98e8 Constants.cs
--- a/Constants.cs	Sat Aug 13 10:42:57 2011 +0000
+++ b/Constants.cs	Sun Aug 14 14:34:12 2011 +0100
@@ -24,13 +24,26 @@
             userDataPath = Path.Combine(Path.Combine(appDataDir, "IBBoard"), exe);
 		}
 
+		/// <summary>
+		/// Gets the path of the directory that contains the executable.
+		/// </summary>
+		/// <value>
+		/// The path that the executable is in.
+		/// </value>
 		public static string ExecutablePath
 		{
 			get { return executablePath; }
 		}
 		
 		private static string userDataPath;
-		
+
+		/// <summary>
+		/// Gets the standard user data path for this app. This follows a convention of using the app name for the folder
+		/// and putting it in a folder called "IBBoard" to avoid collisions.
+		/// </summary>
+		/// <value>
+		/// The user data path, following the IBBoard convention.
+		/// </value>
 		public static string UserDataPath
 		{
 			get { return userDataPath; }