GhostDoc Enterprise Edition

  • 1
  • 2
  • 3

2022.2.22190 | Updated: 17 Jul 2022

Downloads:

4,743

Downloads of v 2022.2.22190:

60

Maintainer(s):

Software Author(s):

  • submain

  • 1
  • 2
  • 3
GhostDoc Enterprise Edition 2022.2.22190

  • 1
  • 2
  • 3

Some Checks Have Failed or Are Not Yet Complete

Not All Tests Have Passed


Validation Testing Passed


Verification Testing Passed

Details

Scan Testing Resulted in Flagged as a Note:

At least one file within this package has greater than 0 detections, but less than 5

Details
Learn More

Deployment Method: Individual Install, Upgrade, & Uninstall

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

>

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

>

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

>

Deployment Method:

📝 NOTE: This applies to both open source and commercial editions of Chocolatey.

1. Enter Your Internal Repository Url

(this should look similar to https://community.chocolatey.org/api/v2/)


2. Setup Your Environment

1. Ensure you are set for organizational deployment

Please see the organizational deployment guide

2. Get the package into your environment

  • Open Source or Commercial:
    • Proxy Repository - Create a proxy nuget repository on Nexus, Artifactory Pro, or a proxy Chocolatey repository on ProGet. Point your upstream to https://community.chocolatey.org/api/v2/. Packages cache on first access automatically. Make sure your choco clients are using your proxy repository as a source and NOT the default community repository. See source command for more information.
    • You can also just download the package and push it to a repository Download

3. Copy Your Script

choco upgrade ghostdoc-enterprise -y --source="'INTERNAL REPO URL'" [other options]

See options you can pass to upgrade.

See best practices for scripting.

Add this to a PowerShell script or use a Batch script with tools and in places where you are calling directly to Chocolatey. If you are integrating, keep in mind enhanced exit codes.

If you do use a PowerShell script, use the following to ensure bad exit codes are shown as failures:


choco upgrade ghostdoc-enterprise -y --source="'INTERNAL REPO URL'" 
$exitCode = $LASTEXITCODE

Write-Verbose "Exit code was $exitCode"
$validExitCodes = @(0, 1605, 1614, 1641, 3010)
if ($validExitCodes -contains $exitCode) {
  Exit 0
}

Exit $exitCode

- name: Install ghostdoc-enterprise
  win_chocolatey:
    name: ghostdoc-enterprise
    version: '2022.2.22190'
    source: INTERNAL REPO URL
    state: present

See docs at https://docs.ansible.com/ansible/latest/modules/win_chocolatey_module.html.


chocolatey_package 'ghostdoc-enterprise' do
  action    :install
  source   'INTERNAL REPO URL'
  version  '2022.2.22190'
end

See docs at https://docs.chef.io/resource_chocolatey_package.html.


cChocoPackageInstaller ghostdoc-enterprise
{
    Name     = "ghostdoc-enterprise"
    Version  = "2022.2.22190"
    Source   = "INTERNAL REPO URL"
}

Requires cChoco DSC Resource. See docs at https://github.com/chocolatey/cChoco.


package { 'ghostdoc-enterprise':
  ensure   => '2022.2.22190',
  provider => 'chocolatey',
  source   => 'INTERNAL REPO URL',
}

Requires Puppet Chocolatey Provider module. See docs at https://forge.puppet.com/puppetlabs/chocolatey.


4. If applicable - Chocolatey configuration/installation

See infrastructure management matrix for Chocolatey configuration elements and examples.

This package was approved as a trusted package on 17 Jul 2022.

Description

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

tools\chocolateyinstall.ps1
$ErrorActionPreference = 'Stop';

$cacheDirectory = Get-PackageCacheLocation

$packageArgs = @{
  packageName    = $env:chocolateyPackageName
  fileType       = 'exe'
  url            = 'https://submain.com/download/ghostdoc/enterprise/registered/'
  unzipLocation  = $cacheDirectory
  softwareName   = 'GhostDoc Enterprise'
  checksum       = '91b3899dc7a2bb5ba52b7e4a78592c258095d107fe169b1574622b75c2308c1838ed7977bf2fcf41fe2cb7d706246fcd0e108314e31ef0467c06c2ab41e7ca7a'
  checksumType   = 'sha512'
  silentArgs     = ''
  validExitCodes = @(0)
  options        = @{
    Headers = @{
      Referer = 'https://submain.com/download/ghostdoc/enterprise/'
    }
  }
}

[array]$existingKey = Get-UninstallRegistryKey @packageArgs
$toolsDir = (Split-Path -Parent $MyInvocation.MyCommand.Definition)

if ($existingKey.Length -eq 1) {
  $existingKey | ForEach-Object {
    . "$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-Object -First 1 -ExpandProperty FullName

if ($env:chocolateyInstallOverride -ne $true) {
  Start-Process "autohotkey.exe" "$toolsDir\ghostdocInstall.ahk","Enterprise"
}
Install-ChocolateyInstallPackage @packageArgs
tools\chocolateyuninstall.ps1
$ErrorActionPreference = 'Stop';

[array]$key = Get-UninstallRegistryKey -SoftwareName 'GhostDoc Enterprise'
$toolsDir = (Split-Path -Parent $MyInvocation.MyCommand.Definition)

if ($key.Count -eq 1) {
  $key | ForEach-Object {
    . "$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 | ForEach-Object { Write-Warning "- $($_.DisplayName)" }
}
tools\ghostdocInstall.ahk
#NoEnv  ; Recommended for performance and compatibility with future AutoHotkey releases.
; #Warn  ; Enable warnings to assist with detecting common errors.
SendMode Input  ; Recommended for new scripts due to its superior speed and reliability.
SetWorkingDir %A_ScriptDir%  ; Ensures a consistent starting directory.
SetTitleMatchMode, RegEx

edition = %1%
winTitleWelcome = GhostDoc %edition% Setup
winTitleWelcomeText = Click Next to continue
winTitleLicense = GhostDoc %edition% Licence Agreement
winTitleIntegrationText = Visual Studio Intergation
winTitleReady = Ready to Install
winTitleCompleted = Completing the GhostDoc %edition% Setup Wizard

WinWait, %winTitleWelcome%, %winTitleWelcomeText%
ControlSend, Button1, {Enter}, %winTitleWelcome%, %winTitleWelcomeText%

Sleep, 100

WinWait, %winTitleLicense%
Control, Check,, Button2, %winTitleLicense%
ControlSend, Button5, {Enter}, %winTitleLicense%

Sleep, 100
WinWait, %winTitleWelcome%
ControlSend, Button1, {Enter}, %winTitleWelcome%

Sleep, 100
WinWait, %winTitleWelcome%, %winTitleIntegrationText%
ControlSend, Button1, {Enter}, %winTitleWelcome%

Sleep, 100
WinWait, %winTitleWelcome%, %winTitleReady%
ControlSend, Button1, {Enter}, %winTitleWelcome%

Sleep, 1000
WinWait, %winTitleWelcome%, %winTitleCompleted%
ControlSend, Button1, {Enter}, %winTitleWelcome%
tools\helpers.ps1
function UninstallGhostDoc() {
  param($msiGuid)

  $packageArgs = @{
    packageName   = $env:ChocolateyPackageName
    file          = ''
    fileType      = 'msi'
    silentArgs    = "$msiGuid /qn /norestart"
    validExitCodes= @(0)
  }

  Uninstall-ChocolateyPackage @packageArgs
}

Log in or click on link to see number of positives.

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.

Add to Builder Version Downloads Last Updated Status
GhostDoc Enterprise Edition 2022.1.22135 43 Monday, May 16, 2022 Approved
GhostDoc Enterprise Edition 2022.1.22090 37 Friday, April 1, 2022 Approved
GhostDoc Enterprise Edition 2022.1.22055 43 Thursday, February 24, 2022 Approved
GhostDoc Enterprise Edition 2022.1.22020 49 Monday, January 24, 2022 Approved
GhostDoc Enterprise Edition 2022.1.21330 37 Thursday, December 2, 2021 Approved
GhostDoc Enterprise Edition 2021.2.21290 50 Tuesday, October 19, 2021 Approved
GhostDoc Enterprise Edition 2021.2.21150 74 Wednesday, June 2, 2021 Approved
GhostDoc Enterprise Edition 2021.2.21090 72 Thursday, April 1, 2021 Approved
GhostDoc Enterprise Edition 2021.1.20350 102 Tuesday, December 15, 2020 Approved
GhostDoc Enterprise Edition 2020.2.20300 77 Wednesday, November 4, 2020 Approved
GhostDoc Enterprise Edition 2020.2.20270 96 Tuesday, September 29, 2020 Approved
GhostDoc Enterprise Edition 2020.2.20230 87 Friday, August 21, 2020 Approved
GhostDoc Enterprise Edition 2020.2.20200 95 Saturday, August 1, 2020 Approved
GhostDoc Enterprise Edition 2020.1.20070 214 Friday, March 13, 2020 Approved
GhostDoc Enterprise Edition 2019.3.19260 219 Tuesday, September 17, 2019 Approved
GhostDoc Enterprise Edition 2019.2.19200 176 Tuesday, July 23, 2019 Approved
GhostDoc Enterprise Edition 2019.1.19150 153 Tuesday, June 4, 2019 Approved
GhostDoc Enterprise Edition 2019.1.19100 195 Saturday, April 13, 2019 Approved
GhostDoc Enterprise Edition 2018.2.19060 163 Wednesday, March 6, 2019 Approved
GhostDoc Enterprise Edition 2018.2.19030 175 Thursday, February 7, 2019 Approved
GhostDoc Enterprise Edition 2018.1.18330.20190125 160 Friday, January 25, 2019 Approved
GhostDoc Enterprise Edition 2018.1.18330 178 Saturday, December 1, 2018 Approved
GhostDoc Enterprise Edition 2018.1.18310 179 Wednesday, November 7, 2018 Approved
GhostDoc Enterprise Edition 2018.1.18300 203 Wednesday, October 31, 2018 Approved
GhostDoc Enterprise Edition 2018.1.18250 204 Thursday, October 4, 2018 Approved
GhostDoc Enterprise Edition 5.9.18240 188 Sunday, September 2, 2018 Approved
GhostDoc Enterprise Edition 5.9.18070 278 Friday, April 6, 2018 Approved
GhostDoc Enterprise Edition 5.8.17335 327 Tuesday, January 2, 2018 Approved
GhostDoc Enterprise Edition 5.8.17330 319 Sunday, December 3, 2017 Approved
GhostDoc Enterprise Edition 5.8 360 Sunday, October 1, 2017 Approved

[Software Changelog](
Package Changelog

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