Skip to content

Commit

Permalink
Misc adjustments
Browse files Browse the repository at this point in the history
  • Loading branch information
abjerner committed Feb 16, 2023
1 parent 8b92c21 commit 0e2f83c
Show file tree
Hide file tree
Showing 5 changed files with 12 additions and 12 deletions.
2 changes: 1 addition & 1 deletion src/Skybrud.Umbraco.GridData/Models/GridControl.cs
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,7 @@ internal GridControl(GridControl control) : base(control.JObject) {
#region Member methods

/// <summary>
/// Gets the value of the control casted to the type of <typeparamref name="T"/>.
/// Returns the value of the control casted to the type of <typeparamref name="T"/>.
/// </summary>
/// <typeparam name="T">The type of the value to be returned.</typeparam>
public T? GetValue<T>() where T : IGridControlValue {
Expand Down
12 changes: 6 additions & 6 deletions src/Skybrud.Umbraco.GridData/Models/GridDataModel.cs
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,7 @@ public bool IsValid {
#region Member methods

/// <summary>
/// Gets an array of all nested controls.
/// Returns a list of all nested controls.
/// </summary>
public IReadOnlyList<GridControl> GetAllControls() {
return (
Expand All @@ -106,15 +106,15 @@ select control
}

/// <summary>
/// Gets an array of all nested controls with the specified editor <paramref name="alias"/>.
/// Returns a list of all nested controls with the specified editor <paramref name="alias"/>.
/// </summary>
/// <param name="alias">The editor alias of controls to be returned.</param>
public IReadOnlyList<GridControl> GetAllControls(string alias) {
return GetAllControls(x => x.Editor.Alias == alias);
}

/// <summary>
/// Gets an array of all nested controls matching the specified <paramref name="predicate"/>.
/// Returns a list of all nested controls matching the specified <paramref name="predicate"/>.
/// </summary>
/// <param name="predicate">The predicate (callback function) used for comparison.</param>
public IReadOnlyList<GridControl> GetAllControls(Func<GridControl, bool> predicate) {
Expand All @@ -138,7 +138,7 @@ public void WriteSearchableText(GridContext context, TextWriter writer) {
}

/// <summary>
/// Gets a textual representation of the grid model - eg. to be used in Examine.
/// Returns a textual representation of the grid model - eg. to be used in Examine.
/// </summary>
/// <param name="context">The current grid context.</param>
/// <returns>An instance of <see cref="string"/> representing the value of the element.</returns>
Expand All @@ -154,14 +154,14 @@ public string GetSearchableText(GridContext context) {
#region Static methods

/// <summary>
/// Gets an empty (and invalid) model. This method can be used to get a fallback value for when an actual Grid model isn't available.
/// Returns an empty (and invalid) model. This method can be used to get a fallback value for when an actual Grid model isn't available.
/// </summary>
public static GridDataModel GetEmptyModel() {
return new GridDataModel(null, null, null, null);
}

/// <summary>
/// Gets an empty (and invalid) model. This method can be used to get a fallback value for when an actual Grid model isn't available.
/// Returns an empty (and invalid) model. This method can be used to get a fallback value for when an actual Grid model isn't available.
/// </summary>
/// <param name="owner">An instance of <see cref="IPublishedElement"/> representing the owner holding the grid value.</param>
/// <param name="propertyType">An instance of <see cref="IPublishedPropertyType"/> representing the property holding the grid value.</param>
Expand Down
2 changes: 1 addition & 1 deletion src/Skybrud.Umbraco.GridData/Models/GridEditor.cs
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,7 @@ public GridEditor(GridEditor editor) : base(editor.JObject) {
#region Member methods

/// <summary>
/// Gets the config of the editor casted to the type of <typeparamref name="T"/>.
/// Returns the config of the editor casted to the type of <typeparamref name="T"/>.
/// </summary>
/// <typeparam name="T">The type of the config to be returned.</typeparam>
public T? GetConfig<T>() where T : IGridEditorConfig {
Expand Down
6 changes: 3 additions & 3 deletions src/Skybrud.Umbraco.GridData/Models/GridRow.cs
Original file line number Diff line number Diff line change
Expand Up @@ -109,7 +109,7 @@ public GridRow(JObject json, GridSection section, IGridFactory factory) : base(j
#region Member methods

/// <summary>
/// Gets an array of all nested controls.
/// Returns a list of all nested controls.
/// </summary>
public IReadOnlyList<GridControl> GetAllControls() {
return (
Expand All @@ -120,15 +120,15 @@ select control
}

/// <summary>
/// Gets an array of all nested controls with the specified editor <paramref name="alias"/>.
/// Returns a list of all nested controls with the specified editor <paramref name="alias"/>.
/// </summary>
/// <param name="alias">The editor alias of controls to be returned.</param>
public IReadOnlyList<GridControl> GetAllControls(string alias) {
return GetAllControls(x => x.Editor.Alias == alias);
}

/// <summary>
/// Gets an array of all nested controls matching the specified <paramref name="predicate"/>.
/// Returns a list of all nested controls matching the specified <paramref name="predicate"/>.
/// </summary>
/// <param name="predicate">The predicate (callback function) used for comparison.</param>
public IReadOnlyList<GridControl> GetAllControls(Func<GridControl, bool> predicate) {
Expand Down
2 changes: 1 addition & 1 deletion src/Skybrud.Umbraco.GridData/Models/GridSection.cs
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,7 @@ public void WriteSearchableText(GridContext context, TextWriter writer) {
}

/// <summary>
/// Gets a textual representation of the section - eg. to be used in Examine.
/// Returns a textual representation of the section - eg. to be used in Examine.
/// </summary>
/// <param name="context">The current grid context.</param>
/// <returns>An instance of <see cref="string"/> representing the value of the element.</returns>
Expand Down

0 comments on commit 0e2f83c

Please sign in to comment.