Skip to content
This repository has been archived by the owner on Apr 30, 2020. It is now read-only.

No Code Generated for dotnetcoreapp2.0 #96

Open
mikejr83 opened this issue Jul 10, 2018 · 2 comments
Open

No Code Generated for dotnetcoreapp2.0 #96

mikejr83 opened this issue Jul 10, 2018 · 2 comments
Assignees

Comments

@mikejr83
Copy link

I've been working on documenting a microservice written in .NET Core 2.0. I've used the GUI to point it at the solution file and an individual csproj file. Both attempts failed to create an documentation from the XML comments.

Is documentation from XML comments for .NET Core a known limitation or am I just doing something wrong configuring.

SDOX:

<?xml version="1.0" encoding="utf-8" standalone="yes"?>
<SDConfig>
  <section guid="feacbce2-8290-4d90-bb05-373b9d7dbbfc">
    <item key="ConfigFileName" value="html-documentation-builder" />
    <item key="ProjectName" value="Awesome Microservice" />
    <item key="AuthorUrl" value="" />
    <item key="VersionNumber" value="1" />
    <InputFile>
      <Relative>..\microservice\AwesomeProject.sln</Relative>
      <Full>C:\git\awesome-project\microservice\AwesomeProject.sln</Full>
    </InputFile>
    <OutputPath>
      <Relative></Relative>
      <Full>C:\git\awesome-project\docs</Full>
    </OutputPath>
    <item key="DocLanguage" value="en" />
    <item key="ExcludePrivate" value="False" />
    <item key="ExcludeProtected" value="False" />
    <item key="ExcludeInternal" value="False" />
    <item key="ExcludedIdentifiers" value="" />
    <item key="ActivatedExporters" value="Html" />
  </section>
  <section guid="9e8e8bc4-bfdd-11e3-a297-170828518c08">
    <item key="Theme" value="sharpDox" />
    <item key="ShowCode" value="True" />
    <item key="PrimaryColor" value="#F5F4F0" />
    <item key="SecondaryColor" value="#F58026" />
    <item key="DisableSequenceDiagrams" value="False" />
  </section>
</SDConfig>
@mikejr83
Copy link
Author

Update:

I did realize that I did not have XML documentation enabled.

I set GenerateDocumentationFile in all of my csproj files to true. Doing this generated the xml in the form of AssemblyName.xml such that it matched up with AssemblyName.dll. It still produced no output for code.

@geaz
Copy link
Owner

geaz commented Jul 10, 2018

It is not necessary to active the XML documentation generation. Unfortunately sharpDox was not tested on .NET Core until now. I think there are some changes necessary. Maybe I can look into this in a few days.

@geaz geaz self-assigned this Jul 10, 2018
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

No branches or pull requests

2 participants