search

Donaim / time-tracking-server

Nest.js server for tracking tasks
0 stars 0 forks source link

Resolve `@file` bug in `JSDoc` #21

Closed Donaim closed 3 years ago

Donaim commented 3 years ago

Following file is not documented poperly:

/**
 * @file Contains type definitions related to task operations.
 */

/**
 * @typedef {Object} StartTaskResult
 */
export type StartTaskResult = {
  /**
   * HTTP status code for the start task operation
   * @type{number}
   */
  statusCode: number;
};

The StartTaskResult is described as "Contains type definitions related to task operations", but that is file's description.

Donaim commented 3 years ago

It does not seem that JSDoc typedefs are aware of namespaces, so it's probably better to keep them global.