Got rid of the last brace-typed and hyphen-less params etc

Signed-off-by: Fredrik Adelöw <freben@gmail.com>

plugins/jenkins/api-report.md

@@ -49,17 +49,12 @@ export const JENKINS_ANNOTATION = 'jenkins.io/job-full-name';
 //
 // @public (undocumented)
 export interface JenkinsApi {
-  // Warning: (tsdoc-param-tag-with-invalid-name) The @param block should be followed by a valid parameter name: The identifier cannot non-word characters
-  // Warning: (tsdoc-param-tag-with-invalid-name) The @param block should be followed by a valid parameter name: The identifier cannot non-word characters
-  // Warning: (tsdoc-param-tag-with-invalid-name) The @param block should be followed by a valid parameter name: The identifier cannot non-word characters
   // Warning: (ae-forgotten-export) The symbol "Build" needs to be exported by the entry point index.d.ts
   getBuild(options: {
     entity: EntityName;
     jobFullName: string;
     buildNumber: string;
   }): Promise<Build>;
-  // Warning: (tsdoc-param-tag-with-invalid-name) The @param block should be followed by a valid parameter name: The identifier cannot non-word characters
-  // Warning: (tsdoc-param-tag-with-invalid-name) The @param block should be followed by a valid parameter name: The identifier cannot non-word characters
   // Warning: (ae-forgotten-export) The symbol "Project" needs to be exported by the entry point index.d.ts
   getProjects(options: {
     entity: EntityRef;

plugins/jenkins/src/api/JenkinsApi.ts

@@ -77,12 +77,11 @@ export interface JenkinsApi {
    * and by the _Software Engineer_ using annotations agreed with the _Integrator_.
    *
    * Typically, a folder job will be identified and the backend plugin will recursively look for projects (jobs with builds) within that folder.
-   *
-   * @param options.entity the entity whose jobs should be retrieved.
-   * @param options.filter a filter on jobs. Currently this just takes a branch (and assumes certain structures in jenkins)
    */
   getProjects(options: {
+    /** the entity whose jobs should be retrieved. */
     entity: EntityRef;
+    /** a filter on jobs. Currently this just takes a branch (and assumes certain structures in jenkins) */
     filter: { branch?: string };
   }): Promise<Project[]>;
 
@@ -92,9 +91,6 @@ export interface JenkinsApi {
    * This takes an entity to support selecting between multiple jenkins instances.
    *
    * TODO: abstract jobFullName (so we could support differentiating between the same named job on multiple instances).
-   * @param options.entity
-   * @param options.jobFullName
-   * @param options.buildNumber
    */
   getBuild(options: {
     entity: EntityName;

plugins/jenkins/src/components/useBuildWithSteps.ts

@@ -25,8 +25,8 @@ const INTERVAL_AMOUNT = 1500;
 
 /**
  * Hook to expose a specific build.
- * @param jobFullName the full name of the project (job with builds, not a folder). e.g. "department-A/team-1/project-foo/master"
- * @param buildNumber the number of the build. e.g. "13"
+ * @param jobFullName - the full name of the project (job with builds, not a folder). e.g. "department-A/team-1/project-foo/master"
+ * @param buildNumber - the number of the build. e.g. "13"
  */
 export function useBuildWithSteps({
   jobFullName,