Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP

Loading…

Add VisualStudio GhostDoc plugin setting file #994

Closed
wants to merge 1 commit into from

3 participants

Star Peng Markus Olsson Paul Rogero
Star Peng

Add VisualStudio GhostDoc plugin setting file

Star Peng starpeng Add VisualStudio GhostDoc plugin setting file
Add VisualStudio GhostDoc plugin setting file
8646fa1
Markus Olsson
Admin

Thanks @starpeng. I'm a fan of GhostDoc. I've never encountered it creating a GhostDoc.xml file though. Could you describe that file a bit? If it contains information about how to format xml-documentation I could see it being useful for other members of the project as well to produce consistent documentation.

But as I said, I don't know what it does so any information you could share about it would be helpful.

Paul Rogero

@niik I believe the file is %SolutionFile%.GhostDoc.xml so if the solution was CompanyA.MySolution then the xml comment file would be CompanyA.MySolution.sln.GhostDoc.xml I have this file in my solution as well.

I'm running GhostDoc Pro v4.9. Seems to be settings for GhostDoc, see mine below:

<GhostDoc>
  <SpellChecker>
    <IncludeExtensions>
    </IncludeExtensions>
    <IgnoreExtensions>
    </IgnoreExtensions>
    <IgnoreFiles>
    </IgnoreFiles>
  </SpellChecker>
<HelpConfigurations selected="HelpFile">
  <HelpConfiguration name="HelpFile">
    <OutputPath>.\Help</OutputPath>
    <ImageFolderPath />
    <HtmlFormats>
      <HtmlHelp>true</HtmlHelp>
      <MSHelpViewer>false</MSHelpViewer>
      <MSHelp2>false</MSHelp2>
      <Website>false</Website>
    </HtmlFormats>
    <IncludeScopes>
      <Public>true</Public>
      <Internal>false</Internal>
      <Protected>false</Protected>
      <Private>false</Private>
      <Inherited>true</Inherited>
      <EnableTags>false</EnableTags>
      <TagList />
    </IncludeScopes>
    <ResolveCrefLinks>true</ResolveCrefLinks>
    <HeaderText />
    <FooterText />
    <SelectedProjects />
  </HelpConfiguration>
</HelpConfigurations>
</GhostDoc>

Seems like something you'd probably want in source control but I imagine some teams would want to keep it out.

Markus Olsson
Admin

Thanks @rog1039! Based on that I don't think it should go in to the generic .gitignores.

Markus Olsson niik closed this
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Commits on Mar 9, 2014
  1. Star Peng

    Add VisualStudio GhostDoc plugin setting file

    starpeng authored
    Add VisualStudio GhostDoc plugin setting file
This page is out of date. Refresh to see the latest.
Showing with 3 additions and 0 deletions.
  1. +3 −0  VisualStudio.gitignore
3  VisualStudio.gitignore
View
@@ -172,3 +172,6 @@ UpgradeLog*.htm
# Microsoft Fakes
FakesAssemblies/
+
+# GhostDoc plugin setting file
+*.GhostDoc.xml
Something went wrong with that request. Please try again.