close(#142): update minver, and include more xml docs.

fuzzzerd · Feb 16, 2021 · b1e4a56 · b1e4a56
1 parent 01b740b
commit b1e4a56
Show file tree

Hide file tree

Showing 5 changed files with 8 additions and 7 deletions.
diff --git a/src/FMData.Rest/FMData.Rest.csproj b/src/FMData.Rest/FMData.Rest.csproj
@@ -20,7 +20,7 @@
  </PropertyGroup>
 
  <PropertyGroup>
- <MinVerMinimumMajorMinor>4.1</MinVerMinimumMajorMinor>
+ <MinVerMinimumMajorMinor>4.3</MinVerMinimumMajorMinor>
  <MinVerTagPrefix>v</MinVerTagPrefix>
  <MinVerDefaultPreReleasePhase>beta</MinVerDefaultPreReleasePhase>
  </PropertyGroup>

diff --git a/src/FMData.Xml/FMData.Xml.csproj b/src/FMData.Xml/FMData.Xml.csproj
@@ -20,7 +20,7 @@
  </PropertyGroup>
 
  <PropertyGroup>
- <MinVerMinimumMajorMinor>4.1</MinVerMinimumMajorMinor>
+ <MinVerMinimumMajorMinor>4.3</MinVerMinimumMajorMinor>
  <MinVerTagPrefix>v</MinVerTagPrefix>
  <MinVerDefaultPreReleasePhase>beta</MinVerDefaultPreReleasePhase>
  </PropertyGroup>

diff --git a/src/FMData/FMData.csproj b/src/FMData/FMData.csproj
@@ -20,7 +20,7 @@
  </PropertyGroup>
 
  <PropertyGroup>
- <MinVerMinimumMajorMinor>4.1</MinVerMinimumMajorMinor>
+ <MinVerMinimumMajorMinor>4.3</MinVerMinimumMajorMinor>
  <MinVerTagPrefix>v</MinVerTagPrefix>
  <MinVerDefaultPreReleasePhase>beta</MinVerDefaultPreReleasePhase>
  </PropertyGroup>

diff --git a/src/FMData/IFileMakerApiClient.cs b/src/FMData/IFileMakerApiClient.cs
@@ -473,14 +473,15 @@ Task<IEnumerable<T>> SendAsync<T>(
  Func<T, int, object> modId) where T : class, new();
 
  /// <summary>
- /// Find a record or records matching the request.
+ /// Find a record or records matching the request and include a data info model as well as the response.
  /// </summary>
  /// <typeparam name="T">The type of response objects to return.</typeparam>
  /// <param name="req">The find request parameters.</param>
  /// <param name="fmId">Function to assign the FileMaker RecordId to each instance of {T}.</param>
  /// <param name="modId">Function to assign the FileMaker ModId to each instance of {T}.</param>
  /// <param name="includeDataInfo">Indicates whether the data information portion should be parsed.</param>
  /// <returns>An <see cref="IEnumerable{T}"/> matching the request parameters.</returns>
+ /// <remarks>The data info portion of the response is always returned when correctly parsed.</remarks>
  Task<(IEnumerable<T>, DataInfoModel)> SendAsync<T>(
  IFindRequest<T> req,
  bool includeDataInfo,

diff --git a/src/FMData/Responses/DataInfoModel.cs b/src/FMData/Responses/DataInfoModel.cs
@@ -1,12 +1,12 @@
 namespace FMData
 {
  /// <summary>
- /// Contains information about the response.
+ /// Contains information about the response. Source Table, Layout, and Found Count information.
  /// </summary>
  public class DataInfoModel
  {
  /// <summary>
- /// Database the data came from
+ /// Database the data came from.
  /// </summary>
  public string Database { get; set; }
 
@@ -16,7 +16,7 @@ public class DataInfoModel
  public string Layout { get; set; }
 
  /// <summary>
- /// Table the data came from
+ /// Table the data came from.
  /// </summary>
  public string Table { get; set; }