Skip to content

Commit

Permalink
Replaced preview API links with final ones.
Browse files Browse the repository at this point in the history
  • Loading branch information
SvenGroot committed Dec 1, 2022
1 parent 0feadab commit 8973dfa
Show file tree
Hide file tree
Showing 18 changed files with 276 additions and 277 deletions.
3 changes: 1 addition & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,7 @@ applications.
- Generate fully customizable usage help.
- Supports PowerShell-like and POSIX-like parsing rules.</Description>

Ookii.CommandLine is provided in versions for [.Net Standard 2.0, .Net Standard 2.1, and .Net 6.0
and later](#requirements).
Ookii.CommandLine is provided in versions for [.Net Standard 2.0, .Net Standard 2.1, and .Net 6.0 and later](#requirements).

Ookii.CommandLine can be added to your project using [NuGet](https://nuget.org/packages/Ookii.CommandLine).
[Code snippets](docs/CodeSnippets.md) for Visual Studio are available on the
Expand Down
38 changes: 19 additions & 19 deletions docs/Arguments.md
Original file line number Diff line number Diff line change
Expand Up @@ -354,10 +354,10 @@ mode outlined above, with all the same options.

Next, let's take a look at how to [define arguments](DefiningArguments.md).

[`AllowDuplicateDictionaryKeysAttribute`]: https://www.ookii.org/docs/commandline-3.0-preview/html/T_Ookii_CommandLine_AllowDuplicateDictionaryKeysAttribute.htm
[`CommandLineArgument.AllowNull`]: https://www.ookii.org/docs/commandline-3.0-preview/html/P_Ookii_CommandLine_CommandLineArgument_AllowNull.htm
[`CommandLineArgumentException`]: https://www.ookii.org/docs/commandline-3.0-preview/html/T_Ookii_CommandLine_CommandLineArgumentException.htm
[`CommandLineParser`]: https://www.ookii.org/docs/commandline-3.0-preview/html/T_Ookii_CommandLine_CommandLineParser.htm
[`AllowDuplicateDictionaryKeysAttribute`]: https://www.ookii.org/docs/commandline-3.0/html/T_Ookii_CommandLine_AllowDuplicateDictionaryKeysAttribute.htm
[`CommandLineArgument.AllowNull`]: https://www.ookii.org/docs/commandline-3.0/html/P_Ookii_CommandLine_CommandLineArgument_AllowNull.htm
[`CommandLineArgumentException`]: https://www.ookii.org/docs/commandline-3.0/html/T_Ookii_CommandLine_CommandLineArgumentException.htm
[`CommandLineParser`]: https://www.ookii.org/docs/commandline-3.0/html/T_Ookii_CommandLine_CommandLineParser.htm
[`CultureInfo.InvariantCulture`]: https://learn.microsoft.com/dotnet/api/system.globalization.cultureinfo.invariantculture
[`CultureInfo`]: https://learn.microsoft.com/dotnet/api/system.globalization.cultureinfo
[`DateTime`]: https://learn.microsoft.com/dotnet/api/system.datetime
Expand All @@ -367,24 +367,24 @@ Next, let's take a look at how to [define arguments](DefiningArguments.md).
[`FileInfo`]: https://learn.microsoft.com/dotnet/api/system.io.fileinfo
[`FlagsAttribute`]: https://learn.microsoft.com/dotnet/api/system.flagsattribute
[`Int32`]: https://learn.microsoft.com/dotnet/api/system.int32
[`KeyTypeConverterAttribute`]: https://www.ookii.org/docs/commandline-3.0-preview/html/T_Ookii_CommandLine_KeyTypeConverterAttribute.htm
[`KeyTypeConverterAttribute`]: https://www.ookii.org/docs/commandline-3.0/html/T_Ookii_CommandLine_KeyTypeConverterAttribute.htm
[`KeyValuePair<TKey, TValue>`]: https://learn.microsoft.com/dotnet/api/system.collections.generic.keyvaluepair-2
[`KeyValuePairConverter<TKey, TValue>`]: https://www.ookii.org/docs/commandline-3.0-preview/html/T_Ookii_CommandLine_KeyValuePairConverter_2.htm
[`KeyValueSeparatorAttribute`]: https://www.ookii.org/docs/commandline-3.0-preview/html/T_Ookii_CommandLine_KeyValueSeparatorAttribute.htm
[`MultiValueSeparatorAttribute`]: https://www.ookii.org/docs/commandline-3.0-preview/html/T_Ookii_CommandLine_MultiValueSeparatorAttribute.htm
[`ParseOptions.AllowWhiteSpaceValueSeparator`]: https://www.ookii.org/docs/commandline-3.0-preview/html/P_Ookii_CommandLine_ParseOptions_AllowWhiteSpaceValueSeparator.htm
[`ParseOptions.ArgumentNameComparer`]: https://www.ookii.org/docs/commandline-3.0-preview/html/P_Ookii_CommandLine_ParseOptions_ArgumentNameComparer.htm
[`ParseOptions.Culture`]: https://www.ookii.org/docs/commandline-3.0-preview/html/P_Ookii_CommandLine_ParseOptions_Culture.htm
[`ParseOptions.NameValueSeparator`]: https://www.ookii.org/docs/commandline-3.0-preview/html/P_Ookii_CommandLine_ParseOptions_NameValueSeparator.htm
[`ParseOptions`]: https://www.ookii.org/docs/commandline-3.0-preview/html/T_Ookii_CommandLine_ParseOptions.htm
[`ParseOptionsAttribute.AllowWhiteSpaceValueSeparator`]: https://www.ookii.org/docs/commandline-3.0-preview/html/P_Ookii_CommandLine_ParseOptionsAttribute_AllowWhiteSpaceValueSeparator.htm
[`ParseOptionsAttribute.CaseSensitive`]: https://www.ookii.org/docs/commandline-3.0-preview/html/P_Ookii_CommandLine_ParseOptionsAttribute_CaseSensitive.htm
[`ParseOptionsAttribute.NameValueSeparator`]: https://www.ookii.org/docs/commandline-3.0-preview/html/P_Ookii_CommandLine_ParseOptionsAttribute_NameValueSeparator.htm
[`ParseOptionsAttribute`]: https://www.ookii.org/docs/commandline-3.0-preview/html/T_Ookii_CommandLine_ParseOptionsAttribute.htm
[`KeyValuePairConverter<TKey, TValue>`]: https://www.ookii.org/docs/commandline-3.0/html/T_Ookii_CommandLine_KeyValuePairConverter_2.htm
[`KeyValueSeparatorAttribute`]: https://www.ookii.org/docs/commandline-3.0/html/T_Ookii_CommandLine_KeyValueSeparatorAttribute.htm
[`MultiValueSeparatorAttribute`]: https://www.ookii.org/docs/commandline-3.0/html/T_Ookii_CommandLine_MultiValueSeparatorAttribute.htm
[`ParseOptions.AllowWhiteSpaceValueSeparator`]: https://www.ookii.org/docs/commandline-3.0/html/P_Ookii_CommandLine_ParseOptions_AllowWhiteSpaceValueSeparator.htm
[`ParseOptions.ArgumentNameComparer`]: https://www.ookii.org/docs/commandline-3.0/html/P_Ookii_CommandLine_ParseOptions_ArgumentNameComparer.htm
[`ParseOptions.Culture`]: https://www.ookii.org/docs/commandline-3.0/html/P_Ookii_CommandLine_ParseOptions_Culture.htm
[`ParseOptions.NameValueSeparator`]: https://www.ookii.org/docs/commandline-3.0/html/P_Ookii_CommandLine_ParseOptions_NameValueSeparator.htm
[`ParseOptions`]: https://www.ookii.org/docs/commandline-3.0/html/T_Ookii_CommandLine_ParseOptions.htm
[`ParseOptionsAttribute.AllowWhiteSpaceValueSeparator`]: https://www.ookii.org/docs/commandline-3.0/html/P_Ookii_CommandLine_ParseOptionsAttribute_AllowWhiteSpaceValueSeparator.htm
[`ParseOptionsAttribute.CaseSensitive`]: https://www.ookii.org/docs/commandline-3.0/html/P_Ookii_CommandLine_ParseOptionsAttribute_CaseSensitive.htm
[`ParseOptionsAttribute.NameValueSeparator`]: https://www.ookii.org/docs/commandline-3.0/html/P_Ookii_CommandLine_ParseOptionsAttribute_NameValueSeparator.htm
[`ParseOptionsAttribute`]: https://www.ookii.org/docs/commandline-3.0/html/T_Ookii_CommandLine_ParseOptionsAttribute.htm
[`String`]: https://learn.microsoft.com/dotnet/api/system.string
[`System.ComponentModel.TypeConverterAttribute`]: https://learn.microsoft.com/dotnet/api/system.componentmodel.typeconverterattribute
[`TypeConverter`]: https://learn.microsoft.com/dotnet/api/system.componentmodel.typeconverter
[`TypeConverterAttribute`]: https://learn.microsoft.com/dotnet/api/system.componentmodel.typeconverterattribute
[`Uri`]: https://learn.microsoft.com/dotnet/api/system.uri
[`ValueTypeConverterAttribute`]: https://www.ookii.org/docs/commandline-3.0-preview/html/T_Ookii_CommandLine_ValueTypeConverterAttribute.htm
[NullArgumentValue_0]: https://www.ookii.org/docs/commandline-3.0-preview/html/T_Ookii_CommandLine_CommandLineArgumentErrorCategory.htm
[`ValueTypeConverterAttribute`]: https://www.ookii.org/docs/commandline-3.0/html/T_Ookii_CommandLine_ValueTypeConverterAttribute.htm
[NullArgumentValue_0]: https://www.ookii.org/docs/commandline-3.0/html/T_Ookii_CommandLine_CommandLineArgumentErrorCategory.htm
14 changes: 7 additions & 7 deletions docs/ChangeLog.md
Original file line number Diff line number Diff line change
Expand Up @@ -135,13 +135,13 @@ and usage.
Upgrading an existing project that is using Ookii.CommandLine 1.0 to Ookii.CommandLine 2.0 or newer
may require substantial code changes and may change how command lines are parsed.

[`CommandLineParser`]: https://www.ookii.org/docs/commandline-3.0-preview/html/T_Ookii_CommandLine_CommandLineParser.htm
[`CommandLineParser<T>`]: https://www.ookii.org/docs/commandline-3.0-preview/html/T_Ookii_CommandLine_CommandLineParser_1.htm
[`CommandLineParser`]: https://www.ookii.org/docs/commandline-3.0/html/T_Ookii_CommandLine_CommandLineParser.htm
[`CommandLineParser<T>`]: https://www.ookii.org/docs/commandline-3.0/html/T_Ookii_CommandLine_CommandLineParser_1.htm
[`CultureInfo.InvariantCulture`]: https://learn.microsoft.com/dotnet/api/system.globalization.cultureinfo.invariantculture
[`Environment.GetCommandLineArgs()`]: https://learn.microsoft.com/dotnet/api/system.environment.getcommandlineargs
[`ParseOptions`]: https://www.ookii.org/docs/commandline-3.0-preview/html/T_Ookii_CommandLine_ParseOptions.htm
[`ParseOptionsAttribute`]: https://www.ookii.org/docs/commandline-3.0-preview/html/T_Ookii_CommandLine_ParseOptionsAttribute.htm
[`ParseOptions`]: https://www.ookii.org/docs/commandline-3.0/html/T_Ookii_CommandLine_ParseOptions.htm
[`ParseOptionsAttribute`]: https://www.ookii.org/docs/commandline-3.0/html/T_Ookii_CommandLine_ParseOptionsAttribute.htm
[`TypeConverter`]: https://learn.microsoft.com/dotnet/api/system.componentmodel.typeconverter
[Parse()_6]: https://www.ookii.org/docs/commandline-3.0-preview/html/M_Ookii_CommandLine_CommandLineParser_Parse.htm
[Parse<T>()_1]: https://www.ookii.org/docs/commandline-3.0-preview/html/M_Ookii_CommandLine_CommandLineParser_Parse__1.htm
[UsageWriter_1]: https://www.ookii.org/docs/commandline-3.0-preview/html/T_Ookii_CommandLine_UsageWriter.htm
[Parse()_6]: https://www.ookii.org/docs/commandline-3.0/html/M_Ookii_CommandLine_CommandLineParser_Parse.htm
[Parse<T>()_1]: https://www.ookii.org/docs/commandline-3.0/html/M_Ookii_CommandLine_CommandLineParser_Parse__1.htm
[UsageWriter_1]: https://www.ookii.org/docs/commandline-3.0/html/T_Ookii_CommandLine_UsageWriter.htm
56 changes: 28 additions & 28 deletions docs/DefiningArguments.md
Original file line number Diff line number Diff line change
Expand Up @@ -597,42 +597,42 @@ disable either automatic argument using the [`ParseOptions`][].

Next, we'll take a look at how to [parse the arguments we've defined](ParsingArguments.md)

[`AliasAttribute`]: https://www.ookii.org/docs/commandline-3.0-preview/html/T_Ookii_CommandLine_AliasAttribute.htm
[`ArgumentNameAttribute`]: https://www.ookii.org/docs/commandline-3.0-preview/html/T_Ookii_CommandLine_ArgumentNameAttribute.htm
[`ArgumentNameAttribute.IsLong`]: https://www.ookii.org/docs/commandline-3.0-preview/html/P_Ookii_CommandLine_ArgumentNameAttribute_IsLong.htm
[`ArgumentNameAttribute.IsShort`]: https://www.ookii.org/docs/commandline-3.0-preview/html/P_Ookii_CommandLine_ArgumentNameAttribute_IsShort.htm
[`ArgumentNameAttribute.ShortName`]: https://www.ookii.org/docs/commandline-3.0-preview/html/P_Ookii_CommandLine_ArgumentNameAttribute_ShortName.htm
[`CommandLineArgumentAttribute.CancelParsing`]: https://www.ookii.org/docs/commandline-3.0-preview/html/P_Ookii_CommandLine_CommandLineArgumentAttribute_CancelParsing.htm
[`CommandLineArgumentAttribute.DefaultValue`]: https://www.ookii.org/docs/commandline-3.0-preview/html/P_Ookii_CommandLine_CommandLineArgumentAttribute_DefaultValue.htm
[`CommandLineArgumentAttribute.IsLong`]: https://www.ookii.org/docs/commandline-3.0-preview/html/P_Ookii_CommandLine_CommandLineArgumentAttribute_IsLong.htm
[`CommandLineArgumentAttribute.IsRequired`]: https://www.ookii.org/docs/commandline-3.0-preview/html/P_Ookii_CommandLine_CommandLineArgumentAttribute_IsRequired.htm
[`CommandLineArgumentAttribute.IsShort`]: https://www.ookii.org/docs/commandline-3.0-preview/html/P_Ookii_CommandLine_CommandLineArgumentAttribute_IsShort.htm
[`CommandLineArgumentAttribute.Position`]: https://www.ookii.org/docs/commandline-3.0-preview/html/P_Ookii_CommandLine_CommandLineArgumentAttribute_Position.htm
[`CommandLineArgumentAttribute.ShortName`]: https://www.ookii.org/docs/commandline-3.0-preview/html/P_Ookii_CommandLine_CommandLineArgumentAttribute_ShortName.htm
[`CommandLineArgumentAttribute.ValueDescription`]: https://www.ookii.org/docs/commandline-3.0-preview/html/P_Ookii_CommandLine_CommandLineArgumentAttribute_ValueDescription.htm
[`CommandLineArgumentAttribute`]: https://www.ookii.org/docs/commandline-3.0-preview/html/T_Ookii_CommandLine_CommandLineArgumentAttribute.htm
[`CommandLineConstructorAttribute`]: https://www.ookii.org/docs/commandline-3.0-preview/html/T_Ookii_CommandLine_CommandLineConstructorAttribute.htm
[`CommandLineParser.HelpRequested`]: https://www.ookii.org/docs/commandline-3.0-preview/html/P_Ookii_CommandLine_CommandLineParser_HelpRequested.htm
[`CommandLineParser`]: https://www.ookii.org/docs/commandline-3.0-preview/html/T_Ookii_CommandLine_CommandLineParser.htm
[`AliasAttribute`]: https://www.ookii.org/docs/commandline-3.0/html/T_Ookii_CommandLine_AliasAttribute.htm
[`ArgumentNameAttribute`]: https://www.ookii.org/docs/commandline-3.0/html/T_Ookii_CommandLine_ArgumentNameAttribute.htm
[`ArgumentNameAttribute.IsLong`]: https://www.ookii.org/docs/commandline-3.0/html/P_Ookii_CommandLine_ArgumentNameAttribute_IsLong.htm
[`ArgumentNameAttribute.IsShort`]: https://www.ookii.org/docs/commandline-3.0/html/P_Ookii_CommandLine_ArgumentNameAttribute_IsShort.htm
[`ArgumentNameAttribute.ShortName`]: https://www.ookii.org/docs/commandline-3.0/html/P_Ookii_CommandLine_ArgumentNameAttribute_ShortName.htm
[`CommandLineArgumentAttribute.CancelParsing`]: https://www.ookii.org/docs/commandline-3.0/html/P_Ookii_CommandLine_CommandLineArgumentAttribute_CancelParsing.htm
[`CommandLineArgumentAttribute.DefaultValue`]: https://www.ookii.org/docs/commandline-3.0/html/P_Ookii_CommandLine_CommandLineArgumentAttribute_DefaultValue.htm
[`CommandLineArgumentAttribute.IsLong`]: https://www.ookii.org/docs/commandline-3.0/html/P_Ookii_CommandLine_CommandLineArgumentAttribute_IsLong.htm
[`CommandLineArgumentAttribute.IsRequired`]: https://www.ookii.org/docs/commandline-3.0/html/P_Ookii_CommandLine_CommandLineArgumentAttribute_IsRequired.htm
[`CommandLineArgumentAttribute.IsShort`]: https://www.ookii.org/docs/commandline-3.0/html/P_Ookii_CommandLine_CommandLineArgumentAttribute_IsShort.htm
[`CommandLineArgumentAttribute.Position`]: https://www.ookii.org/docs/commandline-3.0/html/P_Ookii_CommandLine_CommandLineArgumentAttribute_Position.htm
[`CommandLineArgumentAttribute.ShortName`]: https://www.ookii.org/docs/commandline-3.0/html/P_Ookii_CommandLine_CommandLineArgumentAttribute_ShortName.htm
[`CommandLineArgumentAttribute.ValueDescription`]: https://www.ookii.org/docs/commandline-3.0/html/P_Ookii_CommandLine_CommandLineArgumentAttribute_ValueDescription.htm
[`CommandLineArgumentAttribute`]: https://www.ookii.org/docs/commandline-3.0/html/T_Ookii_CommandLine_CommandLineArgumentAttribute.htm
[`CommandLineConstructorAttribute`]: https://www.ookii.org/docs/commandline-3.0/html/T_Ookii_CommandLine_CommandLineConstructorAttribute.htm
[`CommandLineParser.HelpRequested`]: https://www.ookii.org/docs/commandline-3.0/html/P_Ookii_CommandLine_CommandLineParser_HelpRequested.htm
[`CommandLineParser`]: https://www.ookii.org/docs/commandline-3.0/html/T_Ookii_CommandLine_CommandLineParser.htm
[`DescriptionAttribute`]: https://learn.microsoft.com/dotnet/api/system.componentmodel.descriptionattribute
[`Dictionary<TKey, TValue>`]: https://learn.microsoft.com/dotnet/api/system.collections.generic.dictionary-2
[`ICollection<T>`]: https://learn.microsoft.com/dotnet/api/system.collections.generic.icollection-1
[`IDictionary<TKey, TValue>`]: https://learn.microsoft.com/dotnet/api/system.collections.generic.idictionary-2
[`List<int>`]: https://learn.microsoft.com/dotnet/api/system.collections.generic.list-1
[`List<string>`]: https://learn.microsoft.com/dotnet/api/system.collections.generic.list-1
[`LocalizedStringProvider`]: https://www.ookii.org/docs/commandline-3.0-preview/html/T_Ookii_CommandLine_LocalizedStringProvider.htm
[`ParseOptions.ArgumentNameTransform`]: https://www.ookii.org/docs/commandline-3.0-preview/html/P_Ookii_CommandLine_ParseOptions_ArgumentNameTransform.htm
[`ParseOptions`]: https://www.ookii.org/docs/commandline-3.0-preview/html/T_Ookii_CommandLine_ParseOptions.htm
[`ParseOptionsAttribute`]: https://www.ookii.org/docs/commandline-3.0-preview/html/T_Ookii_CommandLine_ParseOptionsAttribute.htm
[`ShortAliasAttribute`]: https://www.ookii.org/docs/commandline-3.0-preview/html/T_Ookii_CommandLine_ShortAliasAttribute.htm
[`LocalizedStringProvider`]: https://www.ookii.org/docs/commandline-3.0/html/T_Ookii_CommandLine_LocalizedStringProvider.htm
[`ParseOptions.ArgumentNameTransform`]: https://www.ookii.org/docs/commandline-3.0/html/P_Ookii_CommandLine_ParseOptions_ArgumentNameTransform.htm
[`ParseOptions`]: https://www.ookii.org/docs/commandline-3.0/html/T_Ookii_CommandLine_ParseOptions.htm
[`ParseOptionsAttribute`]: https://www.ookii.org/docs/commandline-3.0/html/T_Ookii_CommandLine_ParseOptionsAttribute.htm
[`ShortAliasAttribute`]: https://www.ookii.org/docs/commandline-3.0/html/T_Ookii_CommandLine_ShortAliasAttribute.htm
[`SortedDictionary<string, int>`]: https://learn.microsoft.com/dotnet/api/system.collections.generic.sorteddictionary-2
[`String`]: https://learn.microsoft.com/dotnet/api/system.string
[`System.ComponentModel.DescriptionAttribute`]: https://learn.microsoft.com/dotnet/api/system.componentmodel.descriptionattribute
[`TypeConverter`]: https://learn.microsoft.com/dotnet/api/system.componentmodel.typeconverter
[`TypeConverterAttribute`]: https://learn.microsoft.com/dotnet/api/system.componentmodel.typeconverterattribute
[`TypeConverterBase<T>`]: https://www.ookii.org/docs/commandline-3.0-preview/html/T_Ookii_CommandLine_TypeConverterBase_1.htm
[`ValueDescriptionAttribute`]: https://www.ookii.org/docs/commandline-3.0-preview/html/T_Ookii_CommandLine_ValueDescriptionAttribute.htm
[CancelParsing_1]: https://www.ookii.org/docs/commandline-3.0-preview/html/P_Ookii_CommandLine_CommandLineArgumentAttribute_CancelParsing.htm
[CommandLineParser.Parse()_2]: https://www.ookii.org/docs/commandline-3.0-preview/html/Overload_Ookii_CommandLine_CommandLineParser_Parse.htm
[DefaultValue_1]: https://www.ookii.org/docs/commandline-3.0-preview/html/P_Ookii_CommandLine_CommandLineArgumentAttribute_DefaultValue.htm
[Parse<T>()_1]: https://www.ookii.org/docs/commandline-3.0-preview/html/M_Ookii_CommandLine_CommandLineParser_Parse__1.htm
[`TypeConverterBase<T>`]: https://www.ookii.org/docs/commandline-3.0/html/T_Ookii_CommandLine_TypeConverterBase_1.htm
[`ValueDescriptionAttribute`]: https://www.ookii.org/docs/commandline-3.0/html/T_Ookii_CommandLine_ValueDescriptionAttribute.htm
[CancelParsing_1]: https://www.ookii.org/docs/commandline-3.0/html/P_Ookii_CommandLine_CommandLineArgumentAttribute_CancelParsing.htm
[CommandLineParser.Parse()_2]: https://www.ookii.org/docs/commandline-3.0/html/Overload_Ookii_CommandLine_CommandLineParser_Parse.htm
[DefaultValue_1]: https://www.ookii.org/docs/commandline-3.0/html/P_Ookii_CommandLine_CommandLineArgumentAttribute_DefaultValue.htm
[Parse<T>()_1]: https://www.ookii.org/docs/commandline-3.0/html/M_Ookii_CommandLine_CommandLineParser_Parse__1.htm
Loading

0 comments on commit 8973dfa

Please sign in to comment.