Explanations in help missing

[Foolius]

using System.IO;

namespace mlctl
{
    class Program
    {
        /// <summary>
        /// summary 
        /// </summary>
        /// <param name="p">first parameter</param>
        /// <param name="i">second parameter</param>
        /// <returns></returns>
        static void Main(FileInfo p, FileInfo i)
        {
            Console.WriteLine(p);
            Console.WriteLine(i);
        }
    }
}

Usage:
  mlctl [options]

Options:
  -p <p>       p
  -i <i>       i
  --version    Display version information

As you can see neither the summary nor the text for the parameter is displayed in the help text.

[Keboo]

@Foolius is the XML file present alongside your program? When using DragonFruit, it relies on the file to read in those values

[Foolius]

No, there is no XML file. The tutorial for dragonfruit doesn't mention any and the dragonfruit example also has none.

[Keboo]

@Foolius the setting for turning on the XML docs should happen automatically when you add the DragonFruit NuGet package. When you compile the DragonFruit sample application you should see the following files:

The DragonFruit.xml file is the one that it is using for those description.

You can verify that it is turned on by right clicking on your project, selecting Properties. Under the Build tab, within the Output section you should see the checkbox for XML documentation file checked. It should look something like this:

[Foolius]

The box for the XML documentation file was unchecked.
I checked it and it works fine now, thank you very much.

I can't remember changing anything in this configuration.
Can we prevent this from happening to someone else?

[jonsequitur]

@Foolius Normally this isn't something you need to do manually. The DragonFruit package includes MSBuild props for this: https://github.com/dotnet/command-line-api/blob/master/src/System.CommandLine.DragonFruit/targets/System.CommandLine.DragonFruit.props#L8

I'm wondering how we can reproduce the issue. How did you add the package reference? Do you have custom props or targets in the project? Other ideas?

Thanks.

[Foolius]

I think it's because of the targetframework. See:

command-line-api/src/System.CommandLine.DragonFruit/System.CommandLine.DragonFruit.csproj

Line 4 in 9604cdf

<TargetFramework>netstandard2.0</TargetFramework>

I don't have a netstandard project.

[jonsequitur]

What's your project's target framework?

[Foolius]

.NET Framework 4.7.2

[RyanGano]

I'm also seeing this issue. I followed the example steps nearly exactly (I changed the FileInfo to string because of a missing using)

My console log (using VS Code):

PS C:\Code\test\FromTutorial2> dotnet new console -o myApp
The template "Console Application" was created successfully.

Processing post-creation actions...
Running 'dotnet restore' on myApp\myApp.csproj...
  Restore completed in 109.82 ms for C:\Code\test\FromTutorial2\myApp\myApp.csproj.        

Restore succeeded.

PS C:\Code\test\FromTutorial2> cd .\myApp\
PS C:\Code\test\FromTutorial2\myApp> dotnet add package System.CommandLine.DragonFruit --version 0.3.0-alpha.19577.1
  Writing C:\Users\Ryan\AppData\Local\Temp\tmp67BC.tmp
info : Adding PackageReference for package 'System.CommandLine.DragonFruit' into project 'C:\Code\test\FromTutorial2\myApp\myApp.csproj'.
info : Restoring packages for C:\Code\test\FromTutorial2\myApp\myApp.csproj...
info : Package 'System.CommandLine.DragonFruit' is compatible with all the specified frameworks in project 'C:\Code\test\FromTutorial2\myApp\myApp.csproj'.
ed to file 'C:\Code\test\FromTutorial2\myApp\myApp.csproj'.
info : Committing restore...
info : Generating MSBuild file C:\Code\test\FromTutorial2\myApp\obj\myApp.csproj.nuget.g.props.       
info : Writing assets file to disk. Path: C:\Code\test\FromTutorial2\myApp\obj\project.assets.json    
log  : Restore completed in 193.86 ms for C:\Code\test\FromTutorial2\myApp\myApp.csproj.
PS C:\Code\test\FromTutorial2\myApp> dotnet run
Hello World!
PS C:\Code\test\FromTutorial2\myApp> dotnet run
Program.cs(10,67): error CS0246: The type or namespace name 'FileInfo' could not be found (are you missing a using directive or an assembly reference?) [C:\Code\test\FromTutorial2\myApp\myApp.csproj]     

The build failed. Fix the build errors and run again.
PS C:\Code\test\FromTutorial2\myApp> dotnet run
The value for --int-option is: 42
The value for --bool-option is: False
The value for --file-option is: null
PS C:\Code\test\FromTutorial2\myApp> dotnet run -- --help
Usage:
  myApp [options]

Options:
  --int-option <int-option>      intOption
  --bool-option                  boolOption
  --file-option <file-option>    fileOption
  --version                      Display version information

PS C:\Code\test\FromTutorial2\myApp>

I do have an xml file bin\Debug\netcoreapp3.1\myApp.xml

<?xml version="1.0"?>
<doc>
    <assembly>
        <name>myApp</name>
    </assembly>
    <members>
        <member name="M:myApp.Program.Main(System.Int32,System.Boolean,System.String)">
            <param name="intOption">An option whose argument is parsed as an int</param>
            <param name="boolOption">An option whose argument is parsed as a bool</param>
            <param name="fileOption">An option whose argument is parsed as a FileInfo</param>
        </member>
    </members>
</doc>

I know that the sample code on GitHub works but it's got a lot of Directory.Build.props/targets that seem to be affecting it. I can still run the sample if I:

1. Update to netcoreapp3.1
2. Directly import the current nuget package (rather than the direct include).

However, as soon as I pull the directory into a new location it stops working.

[sergeibobyr]

I had the same issue while trying to use it in .NET Framework project. Had to manually enable XML output. Another non-obvious thing is that XML file has to be distributed with the EXE and many DLLs. I can merge DLLs into one EXE using ILMerge but XML would need to be separate. It's often important for small CLI utilities to be portable and not require many other files to accompany them. Is there an easy way to include XML as a resource in EXE so that I can distribute a single EXE?

[drittich]

Same issue here, target framework 4.7.2. Checking the box resolved the issue.