@servicenow/sdk - v4.7.0
    Preparing search index...

    Function getJSDocCommentsAndTags

    • This function checks multiple locations for JSDoc comments that apply to a host node. At each location, the whole comment may apply to the node, or only a specific tag in the comment. In the first case, location adds the entire JSDoc object. In the second case, it adds the applicable JSDocTag.

      For example, a JSDoc comment before a parameter adds the entire JSDoc. But a @param tag on the parent function only adds the JSDocTag for the @param.

      /** JSDoc will be returned for `a` */
      const a = 0
      /**
      * Entire JSDoc will be returned for `b`
      * @param c JSDocTag will be returned for `c`
      */
      function b(/** JSDoc will be returned for `c` */ c) {}

      Parameters

      Returns readonly (tsc.JSDocTag | tsc.JSDoc)[]