Skip to content

Commit 5e7f2d0

Browse files
committed
add remarks to ArgumentList and ArgumentDictionary
1 parent 9a442b9 commit 5e7f2d0

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

src/Utility.CommandLine.Arguments/Arguments.cs

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -211,11 +211,20 @@ private Arguments(string commandLineString, List<KeyValuePair<string, string>> a
211211
/// Gets a dictionary containing the arguments and values specified in the command line arguments with which the
212212
/// application was started.
213213
/// </summary>
214+
/// <remarks>
215+
/// This dictionary contains argument key/value pairs compiled from the <see cref="ArgumentList"/> and checked against
216+
/// the <see cref="TargetType"/> to combine duplicated pairs into lists where the backing property is a collection, and
217+
/// to overwrite where the backing property is not a collection.
218+
/// </remarks>
214219
public Dictionary<string, object> ArgumentDictionary { get; }
215220

216221
/// <summary>
217222
/// Gets the list of arguments specified in the command line arguments with which the application was started.
218223
/// </summary>
224+
/// <remarks>
225+
/// This list contains each argument key/value pair as supplied in the original string, preserving the original order
226+
/// and any duplicated pairs.
227+
/// </remarks>
219228
public List<KeyValuePair<string, string>> ArgumentList { get; }
220229

221230
/// <summary>

0 commit comments

Comments
 (0)