updated function docs

jsdoc2md · Aug 11, 2024 · a069fa5 · a069fa5
1 parent e43192e
commit a069fa5
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 2 deletions.
diff --git a/helpers/ddata.js b/helpers/ddata.js
@@ -611,7 +611,8 @@ function methodSig () {
 /**
  * extracts url and caption data from @link tags
  * @param {string} - a string containing one or more {@link} tags
- * @returns {Array.<{original: string, caption: string, url: string}>}
+ * @param {object} - `dmdOptions`; link formatting is influenced by the `clever-links` and `monospace-links` values
+ * @returns {Array.<{original: string, caption: string, url: string, format: 'code'|'plain'}>}
  * @static
  */
 function parseLink (text, dmdOptions) {

diff --git a/helpers/helpers.js b/helpers/helpers.js
@@ -40,7 +40,7 @@ function escape (input) {
 }
 
 /**
-replaces {@link} tags with markdown links in the suppied input text
+replaces {@link}, {@linkplain}, and {@linkcode} tags with markdown links in the supplied input text
 */
 function inlineLinks (text, options) {
   if (text) {