--- trunk/gr2lib/Granny2APIVersion.cs 2010/07/14 09:21:43 14
+++ trunk/gr2lib/Granny2APIVersion.cs 2010/07/14 09:55:24 28
@@ -39,17 +39,32 @@ namespace gr2lib.core.apiversion
}
#region IVersionType Members
+ ///
+ /// Returns a string representation of the Granny2 API Version in format (Major.Minor.Customization.Build)
+ ///
public string Version { get { return string.Format("{0}.{1}.{2}.{3}", Major, Minor, Customization, Build); } }
private granny_int32x _Major;
+ ///
+ /// Returns the Major of the Granny2 API Version (X.0.0.0)
+ ///
public granny_int32x Major { get { return _Major; } }
private granny_int32x _Minor;
+ ///
+ /// Returns the Minor of the Granny2 API Version (0.X.0.0)
+ ///
public granny_int32x Minor { get { return _Minor; } }
private granny_int32x _Customization;
+ ///
+ /// Returns the Customization of the Granny2 API Version - Customization (0.0.X.0)
+ ///
public granny_int32x Customization { get { return _Customization; } }
private granny_int32x _Build;
+ ///
+ /// Returns the Build of the Granny2 API Version (0.0.0.X)
+ ///
public granny_int32x Build { get { return _Build; } }
#endregion
}
@@ -62,6 +77,9 @@ namespace gr2lib.core.apiversion
VersionType APIVersion { get; }
VersionType ExpectedAPIVersion { get; }
}
+ ///
+ /// Handle's the checking of the Loaded Granny2 API Version
+ ///
public class Granny2APIVersion : IGranny2APIVersion
{
public Granny2APIVersion()
@@ -81,7 +99,7 @@ namespace gr2lib.core.apiversion
public static string GrannyProductReleaseName = "release";
};
- public bool GrannyVersionsMatch()
+ private bool GrannyVersionsMatch()
{
return gr2lib.core.coreapi.GrannyVersionsMatch(
APIVersionType.GrannyProductMajorVersion,
@@ -89,7 +107,7 @@ namespace gr2lib.core.apiversion
APIVersionType.GrannyProductCustomization,
APIVersionType.GrannyProductBuildNumber);
}
- public void GetGrannyVersion()
+ private void GetGrannyVersion()
{
granny_int32x Major = 0;
granny_int32x Minor = 0;
@@ -105,7 +123,7 @@ namespace gr2lib.core.apiversion
this._APIVersion = new VersionType(Major, Minor, Customization, Build);
}
- public string GrannyGetVersionString()
+ private string GrannyGetVersionString()
{
return gr2lib.core.coreapi.GrannyGetVersionString();
}
@@ -113,9 +131,18 @@ namespace gr2lib.core.apiversion
#region IGranny2APIVersion Members
private bool _APIVersionsMatch = false;
+ ///
+ /// Indicates that the Loaded Granny2 API Version matches the version that the core library was built against
+ ///
public bool APIVersionsMatch { get { return _APIVersionsMatch; } }
private VersionType _APIVersion;
+ ///
+ /// Gets the Loaded Granny2 API Version
+ ///
public VersionType APIVersion { get { return _APIVersion; } }
+ ///
+ /// Gets the Expected Granny2 API Version
+ ///
public VersionType ExpectedAPIVersion { get { return new VersionType(APIVersionType.GrannyProductMajorVersion, APIVersionType.GrannyProductMinorVersion, APIVersionType.GrannyProductCustomization, APIVersionType.GrannyProductBuildNumber); } }
#endregion
}