Updated comment-based-help

AtlassianPS · Mar 16, 2018 · 85d3a35 · 85d3a35
1 parent 86419ee
commit 85d3a35
Show file tree

Hide file tree

Showing 50 changed files with 57 additions and 50 deletions.
diff --git a/JiraPS/Private/ConvertFrom-Json2.ps1 b/JiraPS/Private/ConvertFrom-Json2.ps1
@@ -1,12 +1,19 @@
 function ConvertFrom-Json2 {
+    <#
+    .SYNOPSIS
+        Function to overwrite or be used instead of the native `ConvertFrom-Json` of PowerShell
+    .DESCRIPTION
+        ConvertFrom-Json implementation does not allow for overriding JSON maxlength.
+        The default limit is easy to exceed with large issue lists.
+    #>
     [CmdletBinding()]
     param(
         [Parameter( Mandatory, ValueFromPipeline )]
         [Object[]]
         $InputObject,
 
         [Int]
-        $MaxJsonLength = [int]::MaxValue
+        $MaxJsonLength = [Int]::MaxValue
     )
 
     begin {

diff --git a/JiraPS/Private/ConvertFrom-URLEncoded.ps1 b/JiraPS/Private/ConvertFrom-URLEncoded.ps1
@@ -1,7 +1,7 @@
 function ConvertFrom-URLEncoded {
     <#
     .SYNOPSIS
-    Decode a URL encoded string
+        Decode a URL encoded string
     #>
     [CmdletBinding()]
     [OutputType([String])]

diff --git a/JiraPS/Private/ConvertTo-URLEncoded.ps1 b/JiraPS/Private/ConvertTo-URLEncoded.ps1
@@ -1,7 +1,7 @@
 function ConvertTo-URLEncoded {
     <#
     .SYNOPSIS
-    Encode a string into URL (eg: %20 instead of " ")
+        Encode a string into URL (eg: %20 instead of " ")
     #>
     [CmdletBinding()]
     [OutputType([String])]

diff --git a/JiraPS/Public/Add-JiraIssueAttachment.ps1 b/JiraPS/Public/Add-JiraIssueAttachment.ps1
@@ -1,6 +1,6 @@
 function Add-JiraIssueAttachment {
     <#
-    .Synopsis
+    .SYNOPSIS
        Adds a file attachment to an existing Jira Issue
     .DESCRIPTION
        This function adds an Attachment to an existing issue in JIRA.

diff --git a/JiraPS/Public/Add-JiraIssueComment.ps1 b/JiraPS/Public/Add-JiraIssueComment.ps1
@@ -1,6 +1,6 @@
 function Add-JiraIssueComment {
     <#
-    .Synopsis
+    .SYNOPSIS
        Adds a comment to an existing JIRA issue
     .DESCRIPTION
        This function adds a comment to an existing issue in JIRA. You can optionally set the visibility of the comment (All Users, Developers, or Administrators).

diff --git a/JiraPS/Public/Add-JiraIssueLink.ps1 b/JiraPS/Public/Add-JiraIssueLink.ps1
@@ -1,6 +1,6 @@
 function Add-JiraIssueLink {
     <#
-    .Synopsis
+    .SYNOPSIS
         Adds a link between two Issues on Jira
     .DESCRIPTION
         Creates a new link of the specified type between two Issue.

diff --git a/JiraPS/Public/Add-JiraIssueWatcher.ps1 b/JiraPS/Public/Add-JiraIssueWatcher.ps1
@@ -1,6 +1,6 @@
 function Add-JiraIssueWatcher {
     <#
-    .Synopsis
+    .SYNOPSIS
        Adds a watcher to an existing JIRA issue
     .DESCRIPTION
        This function adds a watcher to an existing issue in JIRA.

diff --git a/JiraPS/Public/Add-JiraIssueWorklog.ps1 b/JiraPS/Public/Add-JiraIssueWorklog.ps1
@@ -1,6 +1,6 @@
 function Add-JiraIssueWorklog {
     <#
-    .Synopsis
+    .SYNOPSIS
        Adds a worklog item to an existing JIRA issue
     .DESCRIPTION
        This function adds a worklog item to an existing issue in JIRA. You can optionally set the visibility of the item (All Users, Developers, or Administrators).

diff --git a/JiraPS/Public/Format-Jira.ps1 b/JiraPS/Public/Format-Jira.ps1
@@ -1,6 +1,6 @@
 function Format-Jira {
     <#
-    .Synopsis
+    .SYNOPSIS
        Converts an object into a table formatted according to JIRA's markdown syntax
     .DESCRIPTION
        This function converts a PowerShell object into a table using JIRA's markdown syntax. This can then be added to a JIRA issue description or comment.

diff --git a/JiraPS/Public/Get-JiraComponent.ps1 b/JiraPS/Public/Get-JiraComponent.ps1
@@ -1,6 +1,6 @@
 function Get-JiraComponent {
     <#
-    .Synopsis
+    .SYNOPSIS
        Returns a Component from Jira
     .DESCRIPTION
        This function returns information regarding a specified component from Jira.

diff --git a/JiraPS/Public/Get-JiraConfigServer.ps1 b/JiraPS/Public/Get-JiraConfigServer.ps1
@@ -1,6 +1,6 @@
 function Get-JiraConfigServer {
     <#
-    .Synopsis
+    .SYNOPSIS
        Obtains the configured URL for the JIRA server
     .DESCRIPTION
        This function returns the configured URL for the JIRA server that JiraPS should manipulate. By default, this is stored in a config.xml file at the module's root path.

diff --git a/JiraPS/Public/Get-JiraField.ps1 b/JiraPS/Public/Get-JiraField.ps1
@@ -1,6 +1,6 @@
 function Get-JiraField {
     <#
-    .Synopsis
+    .SYNOPSIS
        This function returns information about JIRA fields
     .DESCRIPTION
        This function provides information about JIRA fields, or about one field in particular.  This is a good way to identify a field's ID by its name, or vice versa.

diff --git a/JiraPS/Public/Get-JiraFilter.ps1 b/JiraPS/Public/Get-JiraFilter.ps1
@@ -1,6 +1,6 @@
 function Get-JiraFilter {
     <#
-    .Synopsis
+    .SYNOPSIS
        Returns information about a filter in JIRA
     .DESCRIPTION
        This function returns information about a filter in JIRA, including the JQL syntax of the filter, its owner, and sharing status.

diff --git a/JiraPS/Public/Get-JiraGroup.ps1 b/JiraPS/Public/Get-JiraGroup.ps1
@@ -1,6 +1,6 @@
 function Get-JiraGroup {
     <#
-    .Synopsis
+    .SYNOPSIS
        Returns a group from Jira
     .DESCRIPTION
        This function returns information regarding a specified group from JIRA.

diff --git a/JiraPS/Public/Get-JiraGroupMember.ps1 b/JiraPS/Public/Get-JiraGroupMember.ps1
@@ -1,6 +1,6 @@
 function Get-JiraGroupMember {
     <#
-    .Synopsis
+    .SYNOPSIS
        Returns members of a given group in JIRA
     .DESCRIPTION
        This function returns members of a provided group in JIRA.

diff --git a/JiraPS/Public/Get-JiraIssue.ps1 b/JiraPS/Public/Get-JiraIssue.ps1
@@ -1,6 +1,6 @@
 function Get-JiraIssue {
     <#
-    .Synopsis
+    .SYNOPSIS
         Returns information about an issue in JIRA.
     .DESCRIPTION
         This function obtains references to issues in JIRA.

diff --git a/JiraPS/Public/Get-JiraIssueAttachment.ps1 b/JiraPS/Public/Get-JiraIssueAttachment.ps1
@@ -1,6 +1,6 @@
 function Get-JiraIssueAttachment {
     <#
-    .Synopsis
+    .SYNOPSIS
        Returns attachments of an issue in JIRA.
     .DESCRIPTION
        This function obtains attachments from existing issues in JIRA.

diff --git a/JiraPS/Public/Get-JiraIssueComment.ps1 b/JiraPS/Public/Get-JiraIssueComment.ps1
@@ -1,6 +1,6 @@
 function Get-JiraIssueComment {
     <#
-    .Synopsis
+    .SYNOPSIS
        Returns comments on an issue in JIRA.
     .DESCRIPTION
        This function obtains comments from existing issues in JIRA.

diff --git a/JiraPS/Public/Get-JiraIssueCreateMetadata.ps1 b/JiraPS/Public/Get-JiraIssueCreateMetadata.ps1
@@ -1,6 +1,6 @@
 function Get-JiraIssueCreateMetadata {
     <#
-    .Synopsis
+    .SYNOPSIS
        Returns metadata required to create an issue in JIRA
     .DESCRIPTION
        This function returns metadata required to create an issue in JIRA - the fields that can be defined in the process of creating an issue.  This can be used to identify custom fields in order to pass them to New-JiraIssue.

diff --git a/JiraPS/Public/Get-JiraIssueEditMetadata.ps1 b/JiraPS/Public/Get-JiraIssueEditMetadata.ps1
@@ -1,6 +1,6 @@
 function Get-JiraIssueEditMetadata {
     <#
-    .Synopsis
+    .SYNOPSIS
        Returns metadata required to create an issue in JIRA
     .DESCRIPTION
        This function returns metadata required to create an issue in JIRA - the fields that can be defined in the process of creating an issue.  This can be used to identify custom fields in order to pass them to New-JiraIssue.

diff --git a/JiraPS/Public/Get-JiraIssueLink.ps1 b/JiraPS/Public/Get-JiraIssueLink.ps1
@@ -1,6 +1,6 @@
 function Get-JiraIssueLink {
     <#
-    .Synopsis
+    .SYNOPSIS
        Returns a specific issueLink from Jira
     .DESCRIPTION
        This function returns information regarding a specified issueLink from Jira.

diff --git a/JiraPS/Public/Get-JiraIssueType.ps1 b/JiraPS/Public/Get-JiraIssueType.ps1
@@ -1,6 +1,6 @@
 function Get-JiraIssueType {
     <#
-    .Synopsis
+    .SYNOPSIS
         Returns information about the available issue type in JIRA.
     .DESCRIPTION
         This function retrieves all the available IssueType on the JIRA server an returns them as JiraPS.IssueType.

diff --git a/JiraPS/Public/Get-JiraIssueWatcher.ps1 b/JiraPS/Public/Get-JiraIssueWatcher.ps1
@@ -1,6 +1,6 @@
 function Get-JiraIssueWatcher {
     <#
-    .Synopsis
+    .SYNOPSIS
        Returns watchers on an issue in JIRA.
     .DESCRIPTION
        This function obtains watchers from existing issues in JIRA.

diff --git a/JiraPS/Public/Get-JiraPriority.ps1 b/JiraPS/Public/Get-JiraPriority.ps1
@@ -1,6 +1,6 @@
 function Get-JiraPriority {
     <#
-    .Synopsis
+    .SYNOPSIS
         Returns information about the available priorities in JIRA.
     .DESCRIPTION
         This function retrieves all the available Priorities on the JIRA server an returns them as JiraPS.Priority.

diff --git a/JiraPS/Public/Get-JiraProject.ps1 b/JiraPS/Public/Get-JiraProject.ps1
@@ -1,6 +1,6 @@
 function Get-JiraProject {
     <#
-    .Synopsis
+    .SYNOPSIS
        Returns a project from Jira
     .DESCRIPTION
        This function returns information regarding a specified project from Jira. If

diff --git a/JiraPS/Public/Get-JiraRemoteLink.ps1 b/JiraPS/Public/Get-JiraRemoteLink.ps1
@@ -1,6 +1,6 @@
 function Get-JiraRemoteLink {
     <#
-    .Synopsis
+    .SYNOPSIS
        Returns a remote link from a Jira issue
     .DESCRIPTION
        This function returns information on remote links from a  JIRA issue.

diff --git a/JiraPS/Public/Get-JiraServerInformation.ps1 b/JiraPS/Public/Get-JiraServerInformation.ps1
@@ -1,6 +1,6 @@
 function Get-JiraServerInformation {
     <#
-    .Synopsis
+    .SYNOPSIS
        This function returns the information about the JIRA Server
     .DESCRIPTION
        This functions shows all the information about the JIRA server, such as version, time, etc

diff --git a/JiraPS/Public/Get-JiraSession.ps1 b/JiraPS/Public/Get-JiraSession.ps1
@@ -1,6 +1,6 @@
 function Get-JiraSession {
     <#
-    .Synopsis
+    .SYNOPSIS
        Obtains a reference to the currently saved JIRA session
     .DESCRIPTION
        This functio obtains a reference to the currently saved JIRA session.  This can provide

diff --git a/JiraPS/Public/Get-JiraUser.ps1 b/JiraPS/Public/Get-JiraUser.ps1
@@ -1,6 +1,6 @@
 function Get-JiraUser {
     <#
-    .Synopsis
+    .SYNOPSIS
        Returns a user from Jira
     .DESCRIPTION
        This function returns information regarding a specified user from Jira.

diff --git a/JiraPS/Public/Get-JiraVersion.ps1 b/JiraPS/Public/Get-JiraVersion.ps1
@@ -1,6 +1,6 @@
 function Get-JiraVersion {
     <#
-    .Synopsis
+    .SYNOPSIS
        This function returns information about a JIRA Project's Version
     .DESCRIPTION
        This function provides information about JIRA Version

diff --git a/JiraPS/Public/Invoke-JiraIssueTransition.ps1 b/JiraPS/Public/Invoke-JiraIssueTransition.ps1
@@ -1,6 +1,6 @@
 function Invoke-JiraIssueTransition {
     <#
-    .Synopsis
+    .SYNOPSIS
        Performs an issue transition on a JIRA issue, changing its status
     .DESCRIPTION
        This function performs an issue transition on a JIRA issue.  Transitions are

diff --git a/JiraPS/Public/New-JiraGroup.ps1 b/JiraPS/Public/New-JiraGroup.ps1
@@ -1,6 +1,6 @@
 function New-JiraGroup {
     <#
-    .Synopsis
+    .SYNOPSIS
        Creates a new group in JIRA
     .DESCRIPTION
        This function creates a new group in JIRA.

diff --git a/JiraPS/Public/New-JiraIssue.ps1 b/JiraPS/Public/New-JiraIssue.ps1
@@ -1,6 +1,6 @@
 function New-JiraIssue {
     <#
-    .Synopsis
+    .SYNOPSIS
        Creates an issue in JIRA
     .DESCRIPTION
        This function creates a new issue in JIRA.

diff --git a/JiraPS/Public/New-JiraSession.ps1 b/JiraPS/Public/New-JiraSession.ps1
@@ -1,6 +1,6 @@
 function New-JiraSession {
     <#
-    .Synopsis
+    .SYNOPSIS
        Creates a persistent JIRA authenticated session which can be used by other JiraPS functions
     .DESCRIPTION
        This function creates a persistent, authenticated session in to JIRA which can be used by all other

diff --git a/JiraPS/Public/New-JiraUser.ps1 b/JiraPS/Public/New-JiraUser.ps1
@@ -1,6 +1,6 @@
 function New-JiraUser {
     <#
-    .Synopsis
+    .SYNOPSIS
        Creates a new user in JIRA
     .DESCRIPTION
        This function creates a new user in JIRA.  By default, the new user

diff --git a/JiraPS/Public/New-JiraVersion.ps1 b/JiraPS/Public/New-JiraVersion.ps1
@@ -1,6 +1,6 @@
 function New-JiraVersion {
     <#
-    .Synopsis
+    .SYNOPSIS
         Creates a new FixVersion in JIRA
     .DESCRIPTION
          This function creates a new FixVersion in JIRA.

diff --git a/JiraPS/Public/Remove-JiraGroup.ps1 b/JiraPS/Public/Remove-JiraGroup.ps1
@@ -1,6 +1,6 @@
 function Remove-JiraGroup {
     <#
-    .Synopsis
+    .SYNOPSIS
        Removes an existing group from JIRA
     .DESCRIPTION
        This function removes an existing group from JIRA.

diff --git a/JiraPS/Public/Remove-JiraGroupMember.ps1 b/JiraPS/Public/Remove-JiraGroupMember.ps1
@@ -1,6 +1,6 @@
 function Remove-JiraGroupMember {
     <#
-    .Synopsis
+    .SYNOPSIS
        Removes a user from a JIRA group
     .DESCRIPTION
        This function removes a JIRA user from a JIRA group.

diff --git a/JiraPS/Public/Remove-JiraIssueAttachment.ps1 b/JiraPS/Public/Remove-JiraIssueAttachment.ps1
@@ -1,6 +1,6 @@
 function Remove-JiraIssueAttachment {
     <#
-    .Synopsis
+    .SYNOPSIS
        Removes an attachment from a JIRA issue
     .DESCRIPTION
        This function removes an attachment from a JIRA issue.

diff --git a/JiraPS/Public/Remove-JiraIssueLink.ps1 b/JiraPS/Public/Remove-JiraIssueLink.ps1
@@ -1,6 +1,6 @@
 function Remove-JiraIssueLink {
     <#
-    .Synopsis
+    .SYNOPSIS
         Removes a issue link from a JIRA issue
     .DESCRIPTION
         This function removes a issue link from a JIRA issue.

diff --git a/JiraPS/Public/Remove-JiraIssueWatcher.ps1 b/JiraPS/Public/Remove-JiraIssueWatcher.ps1
@@ -1,6 +1,6 @@
 function Remove-JiraIssueWatcher {
     <#
-    .Synopsis
+    .SYNOPSIS
        Removes a watcher from an existing JIRA issue
     .DESCRIPTION
        This function removes a watcher from an existing issue in JIRA.

diff --git a/JiraPS/Public/Remove-JiraRemoteLink.ps1 b/JiraPS/Public/Remove-JiraRemoteLink.ps1
@@ -1,6 +1,6 @@
 function Remove-JiraRemoteLink {
     <#
-    .Synopsis
+    .SYNOPSIS
        Removes a remote link from a JIRA issue
     .DESCRIPTION
        This function removes a remote link from a JIRA issue.

diff --git a/JiraPS/Public/Remove-JiraSession.ps1 b/JiraPS/Public/Remove-JiraSession.ps1
@@ -1,6 +1,6 @@
 function Remove-JiraSession {
     <#
-    .Synopsis
+    .SYNOPSIS
        Removes a persistent JIRA authenticated session
     .DESCRIPTION
        This function removes a persistent JIRA authenticated session and closes the session for JIRA.

diff --git a/JiraPS/Public/Remove-JiraUser.ps1 b/JiraPS/Public/Remove-JiraUser.ps1
@@ -1,6 +1,6 @@
 function Remove-JiraUser {
     <#
-    .Synopsis
+    .SYNOPSIS
        Removes an existing user from JIRA
     .DESCRIPTION
        This function removes an existing user from JIRA.

diff --git a/JiraPS/Public/Remove-JiraVersion.ps1 b/JiraPS/Public/Remove-JiraVersion.ps1
@@ -1,6 +1,6 @@
 function Remove-JiraVersion {
     <#
-    .Synopsis
+    .SYNOPSIS
        This function removes an existing version.
     .DESCRIPTION
        This function removes an existing version in JIRA.

diff --git a/JiraPS/Public/Set-JiraConfigServer.ps1 b/JiraPS/Public/Set-JiraConfigServer.ps1
@@ -1,6 +1,6 @@
 function Set-JiraConfigServer {
     <#
-    .Synopsis
+    .SYNOPSIS
        Defines the configured URL for the JIRA server
     .DESCRIPTION
        This function defines the configured URL for the JIRA server that JiraPS should manipulate. By default, this is stored in a config.xml file at the module's root path.

diff --git a/JiraPS/Public/Set-JiraIssue.ps1 b/JiraPS/Public/Set-JiraIssue.ps1
@@ -1,6 +1,6 @@
 function Set-JiraIssue {
     <#
-    .Synopsis
+    .SYNOPSIS
        Modifies an existing issue in JIRA
     .DESCRIPTION
        This function modifies an existing isue in JIRA.  This can include changing

diff --git a/JiraPS/Public/Set-JiraIssueLabel.ps1 b/JiraPS/Public/Set-JiraIssueLabel.ps1
@@ -1,6 +1,6 @@
 function Set-JiraIssueLabel {
     <#
-    .Synopsis
+    .SYNOPSIS
         Modifies labels on an existing JIRA issue
     .DESCRIPTION
         This function modifies labels on an existing JIRA issue.  There are