From a069fa51a1e1d79c55a8bc253e7aa58a10bfa32d Mon Sep 17 00:00:00 2001 From: Zane Rockenbaugh Date: Sun, 11 Aug 2024 16:47:19 -0500 Subject: [PATCH] updated function docs --- helpers/ddata.js | 3 ++- helpers/helpers.js | 2 +- 2 files changed, 3 insertions(+), 2 deletions(-) diff --git a/helpers/ddata.js b/helpers/ddata.js index 5367445..881a8cc 100644 --- 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 index edb0364..d613b4b 100644 --- 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) {