Update jsdoc

bcgov · Feb 1, 2024 · 86523da · 86523da
1 parent b883a9c
commit 86523da
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 8 deletions.
diff --git a/api/src/repositories/taxonomy-repository.ts b/api/src/repositories/taxonomy-repository.ts
@@ -49,9 +49,8 @@ export class TaxonomyRepository extends BaseRepository {
    * Insert a new taxon record.
    *
    * @param {number} itisTsn
-   * @param {(string | null)} [bcTaxonCode=null]
    * @param {string} itisScientificName
-   * @param {string} commonName
+   * @param {(string | null)} commonName
    * @param {Record<any, any>} itisData
    * @param {string} itisUpdateDate
    * @return {*}  {Promise<TaxonRecord>}

diff --git a/api/src/services/itis-service.ts b/api/src/services/itis-service.ts
@@ -27,9 +27,9 @@ export class ItisService {
   /**
    * Returns the ITIS search species Query.
    *
-   * @param {*} searchTerms
-   * @return {*}  {(Promise<TaxonSearchResult[]>)}
-   * @memberof TaxonomyService
+   * @param {string[]} searchTerms
+   * @return {*}  {Promise<TaxonSearchResult[]>}
+   * @memberof ItisService
    */
   async searchItisByTerm(searchTerms: string[]): Promise<TaxonSearchResult[]> {
     const url = await this.getItisSolrTermSearchUrl(searchTerms);
@@ -49,8 +49,8 @@ export class ItisService {
    * Returns the ITIS search by TSN.
    *
    * @param {number[]} searchTsnIds
-   * @return {*}  {(Promise<ItisSolrSearchResponse[]>)}
-   * @memberof TaxonomyService
+   * @return {*}  {Promise<ItisSolrSearchResponse[]>}
+   * @memberof ItisService
    */
   async searchItisByTSN(searchTsnIds: number[]): Promise<ItisSolrSearchResponse[]> {
     const url = await this.getItisSolrTsnSearchUrl(searchTsnIds);
@@ -70,7 +70,7 @@ export class ItisService {
    * Cleans up the ITIS search response data.
    *
    * @param {ItisSolrSearchResponse[]} data
-   * @memberof TaxonomyService
+   * @memberof ItisService
    */
   _sanitizeItisData = (data: ItisSolrSearchResponse[]): TaxonSearchResult[] => {
     return data.map((item: ItisSolrSearchResponse) => {