Skip to content

Commit 76413af

Browse files
committed
Update xml docs for 2.4 release
1 parent ea20a89 commit 76413af

File tree

4 files changed

+12
-5
lines changed

4 files changed

+12
-5
lines changed

Directory.Build.props

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -51,4 +51,7 @@
5151
<PackageReference Include="Microsoft.NETFramework.ReferenceAssemblies" Version="1.0.0-preview.2" PrivateAssets="all" />
5252
</ItemGroup>
5353

54+
<Import Project="$(MSBuildProjectDirectory)/releasenotes.props"
55+
Condition="Exists('$(MSBuildProjectDirectory)/releasenotes.props')" />
56+
5457
</Project>

src/CommandLineUtils/CommandLineApplication.cs

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -271,14 +271,16 @@ public CommandOption? OptionHelp
271271
/// This property has been marked as obsolete and will be removed in a future version.
272272
/// The recommended replacement for setting this property is <see cref="OnExecute(Func{int})" />
273273
/// and for invoking this property is <see cref="Execute(string[])" />.
274+
/// See https://github.com/natemcmaster/CommandLineUtils/issues/275 for details.
274275
/// </para>
275276
/// <para>
276277
/// The action to call when this command is matched and <see cref="IsShowingInformation"/> is <c>false</c>.
277278
/// </para>
278279
/// </summary>
279280
[Obsolete("This property has been marked as obsolete and will be removed in a future version. " +
280281
"The recommended replacement for setting this property is OnExecute(Func<int>) " +
281-
"and for invoking this property is Execute(string[] args).")]
282+
"and for invoking this property is Execute(string[] args). " +
283+
"See https://github.com/natemcmaster/CommandLineUtils/issues/275 for details.")]
282284
[EditorBrowsable(EditorBrowsableState.Never)]
283285
public Func<int> Invoke
284286
{
@@ -687,14 +689,16 @@ public void OnExecute(Func<int> invoke)
687689
/// <para>
688690
/// This method is obsolete and will be removed in a future version.
689691
/// The recommended alternative is <see cref="OnExecuteAsync" />.
692+
/// See https://github.com/natemcmaster/CommandLineUtils/issues/275 for details.
690693
/// </para>
691694
/// <para>
692695
/// Defines an asynchronous callback.
693696
/// </para>
694697
/// </summary>
695698
/// <param name="invoke"></param>
696699
[Obsolete("This method is obsolete and will be removed in a future version. " +
697-
"The recommended replacement is .OnExecuteAsync()")]
700+
"The recommended replacement is .OnExecuteAsync(). " +
701+
"See https://github.com/natemcmaster/CommandLineUtils/issues/275 for details.")]
698702
[EditorBrowsable(EditorBrowsableState.Never)]
699703
public void OnExecute(Func<Task<int>> invoke) => OnExecuteAsync(_ => invoke());
700704

src/CommandLineUtils/CommandLineApplicationExtensions.cs

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -100,6 +100,7 @@ public static CommandOption VerboseOption(this CommandLineApplication app, strin
100100
/// <para>
101101
/// This method is obsolete and will be removed in a future version.
102102
/// The recommended alternative is <see cref="OnExecuteAsync" />.
103+
/// See https://github.com/natemcmaster/CommandLineUtils/issues/275 for details.
103104
/// </para>
104105
/// <para>
105106
/// Sets an async handler with a return code of <c>0</c>.
@@ -108,7 +109,8 @@ public static CommandOption VerboseOption(this CommandLineApplication app, strin
108109
/// <param name="app"></param>
109110
/// <param name="action">An asynchronous action to invoke when the ocmmand is selected..</param>
110111
[Obsolete("This method is obsolete and will be removed in a future version. " +
111-
"The recommended replacement is .OnExecuteAsync()")]
112+
"The recommended replacement is .OnExecuteAsync(). " +
113+
"See https://github.com/natemcmaster/CommandLineUtils/issues/275 for details.")]
112114
[EditorBrowsable(EditorBrowsableState.Never)]
113115
public static void OnExecute(this CommandLineApplication app, Func<Task> action)
114116
{

src/CommandLineUtils/McMaster.Extensions.CommandLineUtils.csproj

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,5 @@
11
<Project Sdk="Microsoft.NET.Sdk">
22

3-
<Import Project="releasenotes.props" />
4-
53
<PropertyGroup>
64
<TargetFrameworks>netstandard2.0;netstandard1.6;net45</TargetFrameworks>
75
<!--

0 commit comments

Comments
 (0)