Notices: This section not yet converted to new layout. Download stats are rolling back out.

GhostDoc Enterprise Edition

5.8

Package test results are passing.

This package was approved by moderator flcdrg on 10/15/2017.

GhostDoc is a Visual Studio extension that automatically generates XML documentation comments for methods and properties based on their type, parameters, name, and other contextual information.

When generating documentation for class derived from a base class or for interface implementation (e.g. .NET Framework or your custom framework), GhostDoc will use the documentation that Microsoft or the framework vendor has already written for the base class or interface.

Benefits

  • Save keystrokes and time; simplify documenting your code
  • Automatically generate a starting point for your help documentation
  • Benefit of the base class documentation
  • StyleCop compliant documentation templates
  • (Pro) Documentation quality and maintenance
  • (Pro) Code Spell Checker
  • (Pro) Build Help File
  • (Pro) Take control of your help files with Help Configurations and Template Libraries
  • See this page for the full comparison between editions.

If you follow good naming conventions in your code, then you will get very decent results on the summary GhostDoc generates. When I see code that is not documented, it is as simple as hit Ctrl-Shift-D to have GhostDoc document it.

Notes

  • Uninstall is not completely silent, after uninstall a browser window pops up

To install GhostDoc Enterprise Edition, run the following command from the command line or from PowerShell:

C:\> choco install ghostdoc-enterprise

To upgrade GhostDoc Enterprise Edition, run the following command from the command line or from PowerShell:

C:\> choco upgrade ghostdoc-enterprise

Files

Hide
  • tools\chocolateyinstall.ps1 Show
    $ErrorActionPreference = 'Stop';
    
    $cacheDirectory = Get-PackageCacheLocation
    
    $packageArgs = @{
      packageName    = $env:chocolateyPackageName
      fileType       = 'exe'
      url            = 'https://submain.com/download/GhostDocEnt_v5.8.zip'
      unzipLocation  = $cacheDirectory
      softwareName   = 'GhostDoc Enterprise'
      checksum       = 'BA7589E07C1623270F4299A30D09B088A2272E6EBD3E14647E20C999C56F788C233DE706B2A384F1185DCA06E98E893378549E64225C0A083F87BB7981E07BC7'
      checksumType   = 'sha512'
      silentArgs     = ''
      validExitCodes = @(0)
      options        = @{
        Headers = @{
          Referer = 'http://submain.com/download/ghostdoc/enterprise/'
        }
      }
    }
    
    [array]$existingKey = Get-UninstallRegistryKey @packageArgs
    $toolsDir = (Split-Path -Parent $MyInvocation.MyCommand.Definition)
    
    if ($existingKey.Length -eq 1) {
      $existingKey | % {
        . "$toolsDir\helpers.ps1"
        Write-Host "Uninstalling previous version of $($packageArgs.softwareName)"
        UninstallGhostDoc "$($_.PSChildName)"
      }
    }
    
    Install-ChocolateyZipPackage @packageArgs
    
    $packageArgs["file"] = Get-ChildItem $cacheDirectory -Filter "*.exe" -Recurse | select -First 1 -ExpandProperty FullName
    
    if ($env:chocolateyInstallOverride -ne $true) {
      Start-Process "autohotkey.exe" "$toolsDir\ghostdocInstall.ahk"
    }
    Install-ChocolateyInstallPackage @packageArgs
    
  • tools\chocolateyuninstall.ps1 Show
    $ErrorActionPreference = 'Stop';
    
    [array]$key = Get-UninstallRegistryKey -SoftwareName 'GhostDoc Enterprise'
    $toolsDir = (Split-Path -Parent $MyInvocation.MyCommand.Definition)
    
    if ($key.Count -eq 1) {
      $key | % {
        . "$toolsDir\helpers.ps1"
        UninstallGhostDoc "$($_.PSChildName)"
      }
    } elseif ($key.Count -eq 0) {
      Write-Warning "$env:chocolateyPackageName has already been uninstalled by other means."
    } elseif ($key.Count -gt 1) {
      Write-Warning "$($key.Count) matches found!"
      Write-Warning "To prevent accidental data loss, no programs will be uninstalled."
      Write-Warning "Please alert the package maintainer that the following keys were matched:"
      $key | % { Write-Warning "- $($_.DisplayName)" }
    }
    
  • tools\ghostdocInstall.ahk Show
    ; default environment
    DetectHiddenWindows, off
    SetControlDelay, 20
    SetKeyDelay, 10
    
    ; modified environment
    #NoEnv
    DetectHiddenText, off
    SetTitleMatchMode, 1
    
    winTitleWelcome = GhostDoc Enterprise Setup
    winTitleWelcomeText = Click Next to continue
    winTitleLicense = GhostDoc Enterprise Licence Agreement
    winTitleIntegrationText = Visual Studio Intergation
    winTitleReady = Ready to Install
    winTitleCompleted = Completing the GhostDoc Enterprise Setup Wizard
    
    WinWait, %winTitleWelcome%, %winTitleWelcomeText%
    ControlClick, Button1, %winTitleWelcome%, %winTitleWelcomeText%
    
    Sleep, 100
    
    WinWait, %winTitleLicense%
    Control, Check,, Button2, %winTitleLicense%
    ControlClick, Button5, %winTitleLicense%
    
    Sleep, 100
    WinWait, %winTitleWelcome%
    ControlClick, Button1, %winTitleWelcome%
    
    Sleep, 100
    WinWait, %winTitleWelcome%, %winTitleIntegrationText%
    ControlClick, Button1, %winTitleWelcome%
    
    Sleep, 100
    WinWait, %winTitleWelcome%, %winTitleReady%
    ControlClick, Button1, %winTitleWelcome%
    
    Sleep, 1000
    WinWait, %winTitleWelcome%, %winTitleCompleted%
    ControlClick, Button1, %winTitleWelcome%
    
  • tools\helpers.ps1 Show
    function UninstallGhostDoc() {
      param($msiGuid)
    
      $packageArgs = @{
        packageName   = $env:ChocolateyPackageName
        file          = ''
        fileType      = 'msi'
        silentArgs    = "$msiGuid /qn /norestart"
        validExitCodes= @(0)
      }
    
      Uninstall-ChocolateyPackage @packageArgs
    }
    

Virus Scan Results

In cases where actual malware is found, the packages are subject to removal. Software sometimes has false positives. Moderators do not necessarily validate the safety of the underlying software, only that a package retrieves software from the official distribution point and/or validate embedded software against official distribution point (where distribution rights allow redistribution).

Chocolatey Pro provides runtime protection from possible malware.

Dependencies

Maintainer(s)

Software Author(s)

  • submain

Copyright

© 1998-2017 SubMain Software. All rights reserved.

Tags

Release Notes

http://support.submain.com/kb/a42/whats-new-in-ghostdoc-v5.aspx

Version History

Version Downloads Last updated Status

Discussion for the GhostDoc Enterprise Edition Package

Ground rules:

  • This discussion is only about GhostDoc Enterprise Edition and the GhostDoc Enterprise Edition package. If you have feedback for Chocolatey, please contact the google group.
  • This discussion will carry over multiple versions. If you have a comment about a particular version, please note that in your comments.
  • The maintainers of this Chocolatey Package will be notified about new comments that are posted to this Disqus thread, however, it is NOT a guarantee that you will get a response. If you do not hear back from the maintainers after posting a message below, please follow up by using the link on the left side of this page or follow this link to contact maintainers. If you still hear nothing back, please follow the package triage process.
  • Tell us what you love about the package or GhostDoc Enterprise Edition, or tell us what needs improvement.
  • Share your experiences with the package, or extra configuration or gotchas that you've found.
  • If you use a url, the comment will be flagged for moderation until you've been whitelisted. Disqus moderated comments are approved on a weekly schedule if not sooner. It could take between 1-5 days for your comment to show up.

comments powered by Disqus