JSDocs fixes

src/agile/board.ts

@@ -43,8 +43,7 @@ export class Board {
 
   /**
    * Creates a new board. Board name, type and filter ID is required. <ul> <li><code>name</code> - Must be less than 255
-   * characters.</li> <li><code>type</code> - Valid values: scrum, kanban</li>
-   *  <li><code>filterId</code> - ID of a filter that the user has permissions to view. Note, if the user does not have the 'Create shared objects'
+   * characters.</li> <li><code>type</code> - Valid values: scrum, kanban</li> <li><code>filterId</code> - ID of a filter that the user has permissions to view. Note, if the user does not have the 'Create shared objects'
    *  permission and tries to create a shared board, a private board will be created instead (remember that board sharing depends on the filter sharing).</li>
    *  <li><code>location</code> - The container that the board will be located in. <code>location</code> must include the <code>type</code> property (Valid values: project, user).
    *  If choosing 'project', then a project must be specified by a <code>projectKeyOrId</code> property in <code>location</code>.
@@ -72,8 +71,7 @@ export class Board {
   async createBoard<T = Models.CreateBoard>(parameters: Parameters.CreateBoard, callback: Callback<T>): Promise<void>;
   /**
    * Creates a new board. Board name, type and filter ID is required. <ul> <li><code>name</code> - Must be less than 255
-   * characters.</li> <li><code>type</code> - Valid values: scrum, kanban</li>
-   *  <li><code>filterId</code> - ID of a filter that the user has permissions to view. Note, if the user does not have the 'Create shared objects'
+   * characters.</li> <li><code>type</code> - Valid values: scrum, kanban</li> <li><code>filterId</code> - ID of a filter that the user has permissions to view. Note, if the user does not have the 'Create shared objects'
    *  permission and tries to create a shared board, a private board will be created instead (remember that board sharing depends on the filter sharing).</li>
    *  <li><code>location</code> - The container that the board will be located in. <code>location</code> must include the <code>type</code> property (Valid values: project, user).
    *  If choosing 'project', then a project must be specified by a <code>projectKeyOrId</code> property in <code>location</code>.
@@ -226,8 +224,8 @@ export class Board {
   }
 
   /**
-   * Get the board configuration. The response contains the following fields: <ul> <li><code>id</code> - ID of the board.</li> <li><code>name</code> - Name of the board.</li>
-   *  <li><code>filter</code> - Reference to the filter used by the given board.</li>
+   * Get the board configuration. The response contains the following fields: <ul> <li><code>id</code> - ID of the
+   * board.</li> <li><code>name</code> - Name of the board.</li> <li><code>filter</code> - Reference to the filter used by the given board.</li>
    *  <li><code>location</code> - Reference to the container that the board is located in.
    *  Includes the container type (Valid values: project, user).
    *  </li>
@@ -250,8 +248,8 @@ export class Board {
     callback: Callback<T>
   ): Promise<void>;
   /**
-   * Get the board configuration. The response contains the following fields: <ul> <li><code>id</code> - ID of the board.</li> <li><code>name</code> - Name of the board.</li>
-   *  <li><code>filter</code> - Reference to the filter used by the given board.</li>
+   * Get the board configuration. The response contains the following fields: <ul> <li><code>id</code> - ID of the
+   * board.</li> <li><code>name</code> - Name of the board.</li> <li><code>filter</code> - Reference to the filter used by the given board.</li>
    *  <li><code>location</code> - Reference to the container that the board is located in.
    *  Includes the container type (Valid values: project, user).
    *  </li>
@@ -507,10 +505,8 @@ export class Board {
    * the project that belongs to the board. </p> The board filter contains reference the project only if JQL query
    * guarantees that returned issues will be returned from the project set defined in JQL. For instance the query
    * <code>project in (ABC, BCD) AND reporter = admin</code> have reference to ABC and BCD projects but query
-   * <code>project in (ABC, BCD) OR reporter = admin</code> doesn't have reference to any project. </p>
-   *  An issue belongs to the board if its status is mapped to the board's column.
-   *  Epic issues do not belong to the scrum boards.
-   *  </p>
+   * <code>project in (ABC, BCD) OR reporter = admin</code> doesn't have reference to any project. </p> An issue belongs
+   * to the board if its status is mapped to the board's column. Epic issues do not belong to the scrum boards. </p>
    */
   async getProjects<T = Paginated<Models.Projects>>(
     parameters: Parameters.GetProjects,
@@ -523,10 +519,8 @@ export class Board {
    * the project that belongs to the board. </p> The board filter contains reference the project only if JQL query
    * guarantees that returned issues will be returned from the project set defined in JQL. For instance the query
    * <code>project in (ABC, BCD) AND reporter = admin</code> have reference to ABC and BCD projects but query
-   * <code>project in (ABC, BCD) OR reporter = admin</code> doesn't have reference to any project. </p>
-   *  An issue belongs to the board if its status is mapped to the board's column.
-   *  Epic issues do not belong to the scrum boards.
-   *  </p>
+   * <code>project in (ABC, BCD) OR reporter = admin</code> doesn't have reference to any project. </p> An issue belongs
+   * to the board if its status is mapped to the board's column. Epic issues do not belong to the scrum boards. </p>
    */
   async getProjects<T = Paginated<Models.Projects>>(parameters: Parameters.GetProjects, callback?: never): Promise<T>;
   async getProjects<T = Paginated<Models.Projects>>(
@@ -547,8 +541,7 @@ export class Board {
 
   /**
    * Returns all projects that are statically associated with the board, for the given board ID. Returned projects are
-   * ordered by the name. </p> A project is associated with a board if the board filter contains reference the project.
-   * </p> The board filter contains reference the project only if JQL query guarantees that returned issues will be
+   * ordered by the name. </p> A project is associated with a board if the board filter contains reference the project.</p> The board filter contains reference the project only if JQL query guarantees that returned issues will be
    * returned from the project set defined in JQL. For instance the query <code>project in (ABC, BCD) AND reporter =
    * admin</code> have reference to ABC and BCD projects but query <code>project in (ABC, BCD) OR reporter =
    * admin</code> doesn't have reference to any project. </p>
@@ -559,8 +552,7 @@ export class Board {
   ): Promise<void>;
   /**
    * Returns all projects that are statically associated with the board, for the given board ID. Returned projects are
-   * ordered by the name. </p> A project is associated with a board if the board filter contains reference the project.
-   * </p> The board filter contains reference the project only if JQL query guarantees that returned issues will be
+   * ordered by the name. </p> A project is associated with a board if the board filter contains reference the project.</p> The board filter contains reference the project only if JQL query guarantees that returned issues will be
    * returned from the project set defined in JQL. For instance the query <code>project in (ABC, BCD) AND reporter =
    * admin</code> have reference to ABC and BCD projects but query <code>project in (ABC, BCD) OR reporter =
    * admin</code> doesn't have reference to any project. </p>

src/agile/issue.ts

@@ -10,17 +10,15 @@ export class Issue {
   /**
    * Moves (ranks) issues before or after a given issue. At most 50 issues may be ranked at once. <p> This operation may
    * fail for some issues, although this will be rare. In that case the 207 status code is returned for the whole
-   * response and detailed information regarding each issue is available in the response body. </p> <p>
-   *  If rankCustomFieldId is not defined, the default rank field will be used.
-   *  </p>
+   * response and detailed information regarding each issue is available in the response body. </p> <p> If
+   * rankCustomFieldId is not defined, the default rank field will be used. </p>
    */
   async rankIssues<T = void>(parameters: Parameters.RankIssues | undefined, callback: Callback<T>): Promise<void>;
   /**
    * Moves (ranks) issues before or after a given issue. At most 50 issues may be ranked at once. <p> This operation may
    * fail for some issues, although this will be rare. In that case the 207 status code is returned for the whole
-   * response and detailed information regarding each issue is available in the response body. </p> <p>
-   *  If rankCustomFieldId is not defined, the default rank field will be used.
-   *  </p>
+   * response and detailed information regarding each issue is available in the response body. </p> <p> If
+   * rankCustomFieldId is not defined, the default rank field will be used. </p>
    */
   async rankIssues<T = void>(parameters?: Parameters.RankIssues, callback?: never): Promise<T>;
   async rankIssues<T = void>(parameters?: Parameters.RankIssues, callback?: Callback<T>): Promise<void | T> {
@@ -67,12 +65,10 @@ export class Issue {
   /**
    * Returns the estimation of the issue and a fieldId of the field that is used for it. <code>boardId</code> param is
    * required. This param determines which field will be updated on a issue. <p> Original time internally stores and
-   * returns the estimation as a number of seconds. </p> <p>
-   *  The field used for estimation on the given board can be obtained from <a href="#agile/1.0/board-getConfiguration">board configuration resource</a>.
-   *  More information about the field are returned by
-   *  <a href="#api-rest-api-<ver>-issue-getEditIssueMeta">edit meta resource</a>
-   *  or <a href="#api-rest-api-<ver>-field-get">field resource</a>.
-   *  </p>
+   * returns the estimation as a number of seconds. </p> <p> The field used for estimation on the given board can be
+   * obtained from <a href="#agile/1.0/board-getConfiguration">board configuration resource</a>. More information about
+   * the field are returned by <a href="#api-rest-api-<ver>-issue-getEditIssueMeta">edit meta resource</a> or <a
+   * href="#api-rest-api-<ver>-field-get">field resource</a>. </p>
    */
   async getIssueEstimationForBoard<T = unknown>(
     parameters: Parameters.GetIssueEstimationForBoard,
@@ -81,12 +77,10 @@ export class Issue {
   /**
    * Returns the estimation of the issue and a fieldId of the field that is used for it. <code>boardId</code> param is
    * required. This param determines which field will be updated on a issue. <p> Original time internally stores and
-   * returns the estimation as a number of seconds. </p> <p>
-   *  The field used for estimation on the given board can be obtained from <a href="#agile/1.0/board-getConfiguration">board configuration resource</a>.
-   *  More information about the field are returned by
-   *  <a href="#api-rest-api-<ver>-issue-getEditIssueMeta">edit meta resource</a>
-   *  or <a href="#api-rest-api-<ver>-field-get">field resource</a>.
-   *  </p>
+   * returns the estimation as a number of seconds. </p> <p> The field used for estimation on the given board can be
+   * obtained from <a href="#agile/1.0/board-getConfiguration">board configuration resource</a>. More information about
+   * the field are returned by <a href="#api-rest-api-<ver>-issue-getEditIssueMeta">edit meta resource</a> or <a
+   * href="#api-rest-api-<ver>-field-get">field resource</a>. </p>
    */
   async getIssueEstimationForBoard<T = unknown>(
     parameters: Parameters.GetIssueEstimationForBoard,
@@ -110,10 +104,9 @@ export class Issue {
   /**
    * Updates the estimation of the issue. boardId param is required. This param determines which field will be updated
    * on a issue. <p> Note that this resource changes the estimation field of the issue regardless of appearance the
-   * field on the screen. </p> <p>
-   *  Original time tracking estimation field accepts estimation in formats like "1w", "2d", "3h", "20m" or number which represent number of minutes.
-   *  However, internally the field stores and returns the estimation as a number of seconds.
-   *  </p>
+   * field on the screen. </p> <p> Original time tracking estimation field accepts estimation in formats like "1w",
+   * "2d", "3h", "20m" or number which represent number of minutes. However, internally the field stores and returns the
+   * estimation as a number of seconds. </p>
    *  <p>
    *  The field used for estimation on the given board can be obtained from <a href="#agile/1.0/board-getConfiguration">board configuration resource</a>.
    *  More information about the field are returned by
@@ -128,10 +121,9 @@ export class Issue {
   /**
    * Updates the estimation of the issue. boardId param is required. This param determines which field will be updated
    * on a issue. <p> Note that this resource changes the estimation field of the issue regardless of appearance the
-   * field on the screen. </p> <p>
-   *  Original time tracking estimation field accepts estimation in formats like "1w", "2d", "3h", "20m" or number which represent number of minutes.
-   *  However, internally the field stores and returns the estimation as a number of seconds.
-   *  </p>
+   * field on the screen. </p> <p> Original time tracking estimation field accepts estimation in formats like "1w",
+   * "2d", "3h", "20m" or number which represent number of minutes. However, internally the field stores and returns the
+   * estimation as a number of seconds. </p>
    *  <p>
    *  The field used for estimation on the given board can be obtained from <a href="#agile/1.0/board-getConfiguration">board configuration resource</a>.
    *  More information about the field are returned by

src/agile/models/getBuildByKey.ts

@@ -8,7 +8,7 @@ export interface GetBuildByKey {
   schemaVersion?: string;
   /**
    * An ID that relates a sequence of builds. Depending on your use case this might be a project ID, pipeline ID, plan
-   * key etc. - whatever logical unit_old you use to group a sequence of builds.
+   * key etc. - whatever logical unit you use to group a sequence of builds.
    *
    * The combination of `pipelineId` and `buildNumber` must uniquely identify a build you have provided.
    */

src/agile/models/submitBuilds.ts

@@ -13,7 +13,7 @@ export interface SubmitBuilds {
   acceptedBuilds?: {
     /**
      * An ID that relates a sequence of builds. Depending on your system this might be a project ID, pipeline ID, plan
-     * key etc. - whatever logical unit_old you use to group a sequence of builds.
+     * key etc. - whatever logical unit you use to group a sequence of builds.
      *
      * The combination of `pipelineId` and `buildNumber` must uniquely identify the build.
      */
@@ -38,7 +38,7 @@ export interface SubmitBuilds {
     key: {
       /**
        * An ID that relates a sequence of builds. Depending on your system this might be a project ID, pipeline ID, plan
-       * key etc. - whatever logical unit_old you use to group a sequence of builds.
+       * key etc. - whatever logical unit you use to group a sequence of builds.
        *
        * The combination of `pipelineId` and `buildNumber` must uniquely identify the build.
        */

src/agile/parameters/submitBuilds.ts

@@ -27,7 +27,7 @@ export interface SubmitBuilds {
     schemaVersion?: string;
     /**
      * An ID that relates a sequence of builds. Depending on your use case this might be a project ID, pipeline ID, plan
-     * key etc. - whatever logical unit_old you use to group a sequence of builds.
+     * key etc. - whatever logical unit you use to group a sequence of builds.
      *
      * The combination of `pipelineId` and `buildNumber` must uniquely identify a build you have provided.
      */