Added doxygen comments
[people/mcb30/basetools.git] / Source / Python / Workspace / MetaFileTable.py
index d41f6e5..22e2afa 100644 (file)
@@ -1,5 +1,5 @@
 ## @file\r
-# This file is used to create/update/query/erase a common table\r
+# This file is used to create/update/query/erase a meta file table\r
 #\r
 # Copyright (c) 2008, Intel Corporation\r
 # All rights reserved. This program and the accompanying materials\r
@@ -18,7 +18,9 @@ import Common.EdkLogger as EdkLogger
 from MetaDataTable import Table\r
 from MetaDataTable import ConvertToSqlString\r
 \r
+## Python class representation of table storing module data\r
 class ModuleTable(Table):\r
+    # TRICK: use file ID as the part before '.'\r
     _ID_STEP_ = 0.00000001\r
     _ID_MAX_  = 0.99999999\r
     _COLUMN_ = '''\r
@@ -36,23 +38,22 @@ class ModuleTable(Table):
         EndColumn INTEGER NOT NULL,\r
         Enabled INTEGER DEFAULT 0\r
         '''\r
+    # used as table end flag, in case the changes to database is not committed to db file\r
     _DUMMY_ = "-1, -1, '====', '====', '====', '====', '====', -1, -1, -1, -1, -1, -1"\r
 \r
+    ## Constructor\r
     def __init__(self, Cursor, Name='Inf', IdBase=0, Temporary=False):\r
         Table.__init__(self, Cursor, Name, IdBase, Temporary)\r
 \r
-    #\r
-    # Insert a record into table Inf\r
+    ## Insert a record into table Inf\r
     #\r
     # @param Model:          Model of a Inf item\r
     # @param Value1:         Value1 of a Inf item\r
     # @param Value2:         Value2 of a Inf item\r
     # @param Value3:         Value3 of a Inf item\r
-    # @param Value4:         Value4 of a Inf item\r
-    # @param Value5:         Value5 of a Inf item\r
-    # @param Arch:           Arch of a Inf item\r
+    # @param Scope1:         Arch of a Inf item\r
+    # @param Scope2          Platform os a Inf item\r
     # @param BelongsToItem:  The item belongs to which another item\r
-    # @param BelongsToFile:  The item belongs to which dsc file\r
     # @param StartLine:      StartLine of a Inf item\r
     # @param StartColumn:    StartColumn of a Inf item\r
     # @param EndLine:        EndLine of a Inf item\r
@@ -80,7 +81,9 @@ class ModuleTable(Table):
 \r
     ## Query table\r
     #\r
-    # @param Model:  The Model of Record \r
+    # @param    Model:      The Model of Record \r
+    # @param    Arch:       The Arch attribute of Record \r
+    # @param    Platform    The Platform attribute of Record \r
     #\r
     # @retval:       A recordSet of all found records \r
     #\r
@@ -96,9 +99,10 @@ class ModuleTable(Table):
         SqlCommand = "SELECT %s FROM %s WHERE %s" % (ValueString, self.Table, ConditionString)\r
         return self.Exec(SqlCommand)\r
 \r
+## Python class representation of table storing package data\r
 class PackageTable(Table):\r
     _ID_STEP_ = 0.00000001\r
-    _ID_MAX_ = 1\r
+    _ID_MAX_ = 0.99999999\r
     _COLUMN_ = '''\r
         ID REAL PRIMARY KEY,\r
         Model INTEGER NOT NULL,\r
@@ -114,7 +118,10 @@ class PackageTable(Table):
         EndColumn INTEGER NOT NULL,\r
         Enabled INTEGER DEFAULT 0\r
         '''\r
+    # used as table end flag, in case the changes to database is not committed to db file\r
     _DUMMY_ = "-1, -1, '====', '====', '====', '====', '====', -1, -1, -1, -1, -1, -1"\r
+\r
+    ## Constructor\r
     def __init__(self, Cursor, Name='Dec', IdBase=0, Temporary=False):\r
         Table.__init__(self, Cursor, Name, IdBase, Temporary)\r
 \r
@@ -126,9 +133,9 @@ class PackageTable(Table):
     # @param Value1:         Value1 of a Dec item\r
     # @param Value2:         Value2 of a Dec item\r
     # @param Value3:         Value3 of a Dec item\r
-    # @param Arch:           Arch of a Dec item\r
+    # @param Scope1:         Arch of a Dec item\r
+    # @param Scope2:         Module type of a Dec item\r
     # @param BelongsToItem:  The item belongs to which another item\r
-    # @param BelongsToFile:  The item belongs to which dsc file\r
     # @param StartLine:      StartLine of a Dec item\r
     # @param StartColumn:    StartColumn of a Dec item\r
     # @param EndLine:        EndLine of a Dec item\r
@@ -156,7 +163,8 @@ class PackageTable(Table):
 \r
     ## Query table\r
     #\r
-    # @param Model:  The Model of Record \r
+    # @param    Model:  The Model of Record \r
+    # @param    Arch:   The Arch attribute of Record \r
     #\r
     # @retval:       A recordSet of all found records \r
     #\r
@@ -170,9 +178,10 @@ class PackageTable(Table):
         SqlCommand = "SELECT %s FROM %s WHERE %s" % (ValueString, self.Table, ConditionString)\r
         return self.Exec(SqlCommand)\r
 \r
+## Python class representation of table storing platform data\r
 class PlatformTable(Table):\r
     _ID_STEP_ = 0.00000001\r
-    _ID_MAX_ = 1\r
+    _ID_MAX_ = 0.99999999\r
     _COLUMN_ = '''\r
         ID REAL PRIMARY KEY,\r
         Model INTEGER NOT NULL,\r
@@ -189,7 +198,10 @@ class PlatformTable(Table):
         EndColumn INTEGER NOT NULL,\r
         Enabled INTEGER DEFAULT 0\r
         '''\r
+    # used as table end flag, in case the changes to database is not committed to db file\r
     _DUMMY_ = "-1, -1, '====', '====', '====', '====', '====', -1, -1, -1, -1, -1, -1, -1"\r
+\r
+    ## Constructor\r
     def __init__(self, Cursor, Name='Dsc', IdBase=0, Temporary=False):\r
         Table.__init__(self, Cursor, Name, IdBase, Temporary)\r
 \r
@@ -201,9 +213,10 @@ class PlatformTable(Table):
     # @param Value1:         Value1 of a Dsc item\r
     # @param Value2:         Value2 of a Dsc item\r
     # @param Value3:         Value3 of a Dsc item\r
-    # @param Arch:           Arch of a Dsc item\r
+    # @param Scope1:         Arch of a Dsc item\r
+    # @param Scope2:         Module type of a Dsc item\r
     # @param BelongsToItem:  The item belongs to which another item\r
-    # @param BelongsToFile:  The item belongs to which dsc file\r
+    # @param FromItem:       The item belongs to which dsc file\r
     # @param StartLine:      StartLine of a Dsc item\r
     # @param StartColumn:    StartColumn of a Dsc item\r
     # @param EndLine:        EndLine of a Dsc item\r
@@ -232,7 +245,11 @@ class PlatformTable(Table):
 \r
     ## Query table\r
     #\r
-    # @param Model:  The Model of Record \r
+    # @param Model:          The Model of Record \r
+    # @param Scope1:         Arch of a Dsc item\r
+    # @param Scope2:         Module type of a Dsc item\r
+    # @param BelongsToItem:  The item belongs to which another item\r
+    # @param FromItem:       The item belongs to which dsc file\r
     #\r
     # @retval:       A recordSet of all found records \r
     #\r
@@ -254,7 +271,5 @@ class PlatformTable(Table):
             ConditionString += " AND FromItem=%s" % FromItem\r
 \r
         SqlCommand = "SELECT %s FROM %s WHERE %s" % (ValueString, self.Table, ConditionString)\r
-        #print SqlCommand\r
         return self.Exec(SqlCommand)\r
 \r
-\r