geaz / sharpDox

A c# documentation tool (Discontinued)
http://sharpdox.de
MIT License
164 stars 37 forks source link

No Code Generated for dotnetcoreapp2.0 #96

Open mikejr83 opened 6 years ago

mikejr83 commented 6 years ago

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 commented 6 years ago

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 commented 6 years ago

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.