Skip to content

Commit

Permalink
doccomments: Apply grammar fixes from @acizmarik's code review
Browse files Browse the repository at this point in the history
Co-authored-by: Andrej Čižmárik <[email protected]>
  • Loading branch information
exyi and acizmarik committed Feb 1, 2023
1 parent eead0a7 commit 7d74406
Show file tree
Hide file tree
Showing 5 changed files with 7 additions and 7 deletions.
4 changes: 2 additions & 2 deletions src/Framework/Core/ViewModel/Direction.cs
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,9 @@
namespace DotVVM.Framework.ViewModel
{
///<summary>
/// Specifies on which requests should the property should serialized and sent. Default is <see cref="Direction.Both">Both</see>.
/// Specifies on which requests should the property be serialized and sent. Default is <see cref="Direction.Both">Both</see>.
/// Set to <see cref="Direction.None">None</see> to disable serialization of the property.
/// This enums is flags, the directions can be arbitrarily combined.
/// This enumeration can be treated as flags, the directions can be arbitrarily combined.
///</summary>
[Flags]
public enum Direction
Expand Down
4 changes: 2 additions & 2 deletions src/Framework/Framework/Binding/DotvvmBindingCacheHelper.cs
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ public DotvvmBindingCacheHelper(IDotvvmCacheAdapter cache, BindingCompilationSer
this.compilationService = compilationService;
}

/// <summary> Created a new binding using the <paramref name="factory"/>, unless an existing cache entry is found. Entries are identified using the identifier and keys. By default, the cache is LRU with size=1000 </summary>
/// <summary> Creates a new binding using the <paramref name="factory"/>, unless an existing cache entry is found. Entries are identified using the identifier and keys. By default, the cache is LRU with size=1000 </summary>
public T CreateCachedBinding<T>(string identifier, object?[] keys, Func<T> factory) where T: IBinding
{
return this.cache.GetOrAdd(new CacheKey(typeof(T), identifier, keys), _ => {
Expand All @@ -32,7 +32,7 @@ public T CreateCachedBinding<T>(string identifier, object?[] keys, Func<T> facto
});
}

/// <summary> Created a new binding of type <typeparamref name="T"/> with the specified properties, unless an existing cache entry is found. Entries are identified using the identifier and keys. By default, the cache is LRU with size=1000 </summary>
/// <summary> Creates a new binding of type <typeparamref name="T"/> with the specified properties, unless an existing cache entry is found. Entries are identified using the identifier and keys. By default, the cache is LRU with size=1000 </summary>
public T CreateCachedBinding<T>(string identifier, object[] keys, object[] properties) where T: IBinding
{
return CreateCachedBinding<T>(identifier, keys, () => (T)BindingFactory.CreateBinding(this.compilationService, typeof(T), properties));
Expand Down
2 changes: 1 addition & 1 deletion src/Framework/Framework/Binding/Expressions/IBinding.cs
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

namespace DotVVM.Framework.Binding.Expressions
{
/// <summary> Controls what happens when the binding property does not exist on this binding or when it's resolver throws an exception. </summary>
/// <summary> Controls what happens when the binding property does not exist on this binding or when its resolver throws an exception. </summary>
public enum ErrorHandlingMode
{
/// <summary> Returns null. The null is returned even in case when resolver throws an exception, you can't distinguish between the "property does not exist", "resolver failed" states using this mode. </summary>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@

namespace DotVVM.Framework.Binding.Expressions
{
/// <summary> The `{staticCommand: ...}` binding. It is a command, so should be used to handle events, but compared to `command`, it runs primarily client-side. Compared to `value` binding, `staticCommand`s are expected to have side effects and run asynchronously (the binding will return a Promise or a Task). </summary>
/// <summary> The `{staticCommand: ...}` binding. It is a command that runs primarily client-side and is well-suited to handle events. Compared to `value` binding, `staticCommand`s are expected to have side effects and run asynchronously (the binding will return a Promise or a Task). </summary>
[BindingCompilationRequirements(
required: new[] { typeof(StaticCommandOptionsLambdaJavascriptProperty), /*typeof(BindingDelegate)*/ }
)]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -318,7 +318,7 @@ public bool Remove(KeyValuePair<string, TValue> item)
return false;
}

/// <summary> Enumerates all keys and values. If a property contains a binding, the it will be automatically evaluated. </summary>
/// <summary> Enumerates all keys and values. If a property contains a binding, it will be automatically evaluated. </summary>
public IEnumerator<KeyValuePair<string, TValue>> GetEnumerator()
{
foreach (var (p, value) in control.properties)
Expand Down

0 comments on commit 7d74406

Please sign in to comment.