[longomatch/redesign3: 66/156] Document ProjectDescription



commit 2891b57cce3aa595cdec4836e0f2a4fb566bfbf5
Author: Andoni Morales Alastruey <ylatuya gmail com>
Date:   Mon Jan 31 21:48:43 2011 +0100

    Document ProjectDescription

 LongoMatch/Store/ProjectDescription.cs |   35 +++++++++++++++++++++++++++++--
 1 files changed, 32 insertions(+), 3 deletions(-)
---
diff --git a/LongoMatch/Store/ProjectDescription.cs b/LongoMatch/Store/ProjectDescription.cs
index 02f0ba7..8c928c9 100644
--- a/LongoMatch/Store/ProjectDescription.cs
+++ b/LongoMatch/Store/ProjectDescription.cs
@@ -24,55 +24,81 @@ namespace LongoMatch.Store
 {
 
 	/// <summary>
-	/// I'm used like a presentation card for projects. I speed up the retrieval
-	/// from the database be using only the field required to describe a project
+	/// Describes a project in LongoMatch.
 	/// </summary>
 	[Serializable]
 	public class ProjectDescription :  IComparable
 	{
 		
+		/// <summary>
+		/// Title of the project
+		/// </summary>
 		public String Title {
 			get {
 				return System.IO.Path.GetFileNameWithoutExtension(File.FilePath);
 			}
 		}
 
+		/// <summary>
+		/// Media file asigned to this project 
+		/// </summary>
 		public PreviewMediaFile File {
 			get;
 			set;
 		}
 
+		/// <summary>
+		/// Season of the game 
+		/// </summary>
 		public String Season {
 			get;
 			set;
 		}
 
+		/// <summary>
+		/// Comptetition of the game
+		/// </summary>
 		public String Competition {
 			get;
 			set;
 		}
 
+		/// <summary>
+		/// Name of the local team
+		/// </summary>
 		public String LocalName {
 			get;
 			set;
 		}
 
+
+		/// <summary>
+		/// Name of the visitor team
+		/// </summary>
 		public String VisitorName {
 			get;
 			set;
 		}
 
+		/// <summary>
+		/// Goals of the local team
+		/// </summary>
 		public int LocalGoals {
 			get;
 			set;
 		}
 
+		/// <summary>
+		/// Goals of the visitor team
+		/// </summary>
 		public int VisitorGoals {
 			get;
 			set;
 		}
 
-
+		/// <summary>
+		/// Date of the game
+		/// </summary>
 		public DateTime MatchDate {
 			get;
 			set;
@@ -88,6 +114,9 @@ namespace LongoMatch.Store
 			set;
 		}
 		
+		/// <summary>
+		/// String representing the video format like "widhtxheight fps"
+		/// </summary>
 		public String Format {
 			get{
 				return String.Format("{0}x{1} {2}fps", 



[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]