API documentation not getting generated from docfx 2.17.2
See original GitHub issueTitle
docfx not generating API documentation either from docfx.json or directly using the csproj file option in docfx metadata command. Using docfx 2.17.2 console version
Functional impact
Unable to generate the API documentation
Minimal repro steps
Created a .NET core console app with one class Program.cs with a /// comment
namespace ConsoleApp2
{
/// <summary>
/// This is a line for testing Docfx
/// </summary>
class Program
{/// <summary>
/// Main Mehod
/// </summary>
/// <param name="args"></param>
static void Main(string[] args)
{
Console.WriteLine("Hello World!");
}
}
}
Added a docfx.Json file under the same directory as csproj file
{"metadata": [
{
"src": [
{
"files": [
"*.csproj"
],
"exclude": [
"**/bin/**",
"**/obj/**",
"_site/**"
]
}
],
"dest": "api",
"properties": {
"TargetFramework": "netcoreapp1.1"
}
}
]
}
Ran docfx metadata in the same directory
Expected result
API documentation to be generated
Actual result
No documentation generated instead getting a message “No metadata is generated for ConsoleApp2”
Further technical details
Z:\Visual Studio 2017\Projects\ConsoleApp2\ConsoleApp2>docfx metadata
[17-05-17 09:19:41.203]Info:Config file docfx.json found, start generating metadata...
[17-05-17 09:19:47.475]Warning:Cache for Z:/Visual Studio 2017/Projects/ConsoleApp2/ConsoleApp2/ConsoleApp2.csproj in Z:\Visual Studio 2017\Projects\ConsoleApp2\ConsoleApp2\obj\xdoc\cache\final\1008420202 is corrupted
[17-05-17 09:19:48.592]Info:'Z:/Visual Studio 2017/Projects/ConsoleApp2/ConsoleApp2/ConsoleApp2.csproj' keep up-to-date since '5/17/2017 9:17:02 AM', cached intermediate result 'Z:/Visual Studio 2017/Projects/ConsoleApp2/ConsoleApp2/obj/xdoc/cache/obj\mgbupq1i.mey' is used.
[17-05-17 09:19:48.807]Warning:No metadata is generated for ConsoleApp2.
[17-05-17 09:19:48.881]Info:Completed executing in 7280.7861 milliseconds.
Build succeeded with warning.
[17-05-17 09:19:48.890]Warning:Cache for Z:/Visual Studio 2017/Projects/ConsoleApp2/ConsoleApp2/ConsoleApp2.csproj in Z:\Visual Studio 2017\Projects\ConsoleApp2\ConsoleApp2\obj\xdoc\cache\final\1008420202 is corrupted
[17-05-17 09:19:48.891]Warning:No metadata is generated for ConsoleApp2.
2 Warning(s)
0 Error(s)and around we go.
Issue Analytics
- State:
- Created 6 years ago
- Comments:5 (3 by maintainers)
Top Results From Across the Web
DocFx does not generate documentation
I'm trying to use DocFx to generate API documentation. I was under the impression that if I added docfx.console as a nuget package...
Read more >Chocolatey Software | DocFX 2.17.4
DocFx is a documentation generation tool for api reference and markdown files! DocFX is an API documentation generator for .NET, currently supporting C#...
Read more >.NET API Docs | docfx
Docfx converts XML documentation comments into rendered HTML documentations. Generate .NET API Docs. To add API docs for a .NET project, add a...
Read more >Chocolatey Software | DocFX 2.17.1
Chocolatey is software management automation for Windows that wraps installers, executables, zips, and scripts into compiled packages.
Read more >docfx 0.0.1-alpha-1523061604
Version Downloads Last updated
2.67.5 21,666 a month ago
2.67.3 14,199 2 months ago
2.67.2 4,662 2 months ago
Read more >
Top Related Medium Post
No results found
Top Related StackOverflow Question
No results found
Troubleshoot Live Code
Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free
Top Related Reddit Thread
No results found
Top Related Hackernoon Post
No results found
Top Related Tweet
No results found
Top Related Dev.to Post
No results found
Top Related Hashnode Post
No results found
Hi, made the class public and the Meta data was generated. Thanks for the help
Exactly my problem… I got sidetracked with solutions for previous metadata bugs (i.e. install VS 2015 build tools).