Downloads:

1,935

Downloads of v 2019.3.19260:

47

Last Update:

17 Sep 2019

Package Maintainer(s):

Software Author(s):

  • submain

Tags:

ghostdoc admin notsilent trial documentation extension

GhostDoc Pro Edition

2019.3.19260 | Updated: 17 Sep 2019

Downloads:

1,935

Downloads of v 2019.3.19260:

47

Maintainer(s):

Software Author(s):

  • submain

GhostDoc Pro Edition 2019.3.19260

This Package Contains an Exempted Check

1 Test Passing and 1 Exempted Test


Validation Testing Passed


Verification Testing Exempt:

ghostdoc-pro can no longer be installed on a system without Visual Studio already installed

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

>

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

>

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

>

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

1. Ensure you are set for organizational deployment

Please see the organizational deployment guide

  • 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://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. Enter your internal repository url

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

4. Choose your deployment method:


choco upgrade ghostdoc-pro -y --source="'STEP 3 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-pro -y --source="'STEP 3 URL'" 
$exitCode = $LASTEXITCODE

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

Exit $exitCode

- name: Ensure ghostdoc-pro installed
  win_chocolatey:
    name: ghostdoc-pro
    state: present
    version: 2019.3.19260
    source: STEP 3 URL

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

Coming early 2020! Central Managment Reporting available now! More information...


chocolatey_package 'ghostdoc-pro' do
  action    :install
  version  '2019.3.19260'
  source   'STEP 3 URL'
end

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


Chocolatey::Ensure-Package
(
    Name: ghostdoc-pro,
    Version: 2019.3.19260,
    Source: STEP 3 URL
);

Requires Otter Chocolatey Extension. See docs at https://inedo.com/den/otter/chocolatey.


cChocoPackageInstaller ghostdoc-pro
{
   Name     = 'ghostdoc-pro'
   Ensure   = 'Present'
   Version  = '2019.3.19260'
   Source   = 'STEP 3 URL'
}

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


package { 'ghostdoc-pro':
  provider => 'chocolatey',
  ensure   => '2019.3.19260',
  source   => 'STEP 3 URL',
}

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


salt '*' chocolatey.install ghostdoc-pro version="2019.3.19260" source="STEP 3 URL"

See docs at https://docs.saltstack.com/en/latest/ref/modules/all/salt.modules.chocolatey.html.

5. 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 Sep 2019.

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/pro/registered/'
  unzipLocation  = $cacheDirectory
  softwareName   = 'GhostDoc Pro'
  checksum       = '38e321c4cca3d25a878f4af6ee5c46c50a21512bd4b36f464b8d8f637eed6197803096a27f1139406c82b781d77f53ff37feebc41e42088b85f35a5728feb1f7'
  checksumType   = 'sha512'
  silentArgs     = ''
  validExitCodes = @(0)
  options        = @{
    Headers = @{
      Referer = 'https://submain.com/download/ghostdoc/pro/'
    }
  }
}

[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 GhostDoc Pro"
    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","Pro"
}
Install-ChocolateyInstallPackage @packageArgs
tools\chocolateyuninstall.ps1
$ErrorActionPreference = 'Stop';

[array]$key = Get-UninstallRegistryKey -SoftwareName 'GhostDoc Pro'
$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
}

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.

Version Downloads Last Updated Status
GhostDoc Pro Edition 2019.2.19200 70 Tuesday, July 23, 2019 Approved
GhostDoc Pro Edition 2019.1.19150 67 Tuesday, June 4, 2019 Approved
GhostDoc Pro Edition 2019.1.19100 66 Saturday, April 13, 2019 Approved
GhostDoc Pro Edition 2018.2.19060 86 Wednesday, March 6, 2019 Approved
GhostDoc Pro Edition 2018.2.19030 48 Thursday, February 7, 2019 Approved
GhostDoc Pro Edition 2018.1.18330.20190125 62 Friday, January 25, 2019 Approved
GhostDoc Pro Edition 2018.1.18330 75 Saturday, December 1, 2018 Approved
GhostDoc Pro Edition 2018.1.18310 90 Wednesday, November 7, 2018 Approved
GhostDoc Pro Edition 2018.1.18300 65 Wednesday, October 31, 2018 Approved
Discussion for the GhostDoc Pro Edition Package

Ground Rules:

  • This discussion is only about GhostDoc Pro Edition and the GhostDoc Pro 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 Pro 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