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