Mercurial > repos > IBBoard
changeset 108:27b6aa1e98e8
Re #12: Document classes and methods
* Document the Constants
(Also - test new Hg repo and hooks)
| author | IBBoard <dev@ibboard.co.uk> |
|---|---|
| date | Sun, 14 Aug 2011 14:34:12 +0100 |
| parents | 0f88d32b22cc |
| children | 93081f4df6b8 |
| files | Constants.cs |
| diffstat | 1 files changed, 14 insertions(+), 1 deletions(-) [+] |
line wrap: on
line diff
--- 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; }