diff --git a/docs/links-package/inline-tag-defs/link.js b/docs/links-package/inline-tag-defs/link.js index a1c4c5a047..58e2dee79a 100644 --- a/docs/links-package/inline-tag-defs/link.js +++ b/docs/links-package/inline-tag-defs/link.js @@ -1,5 +1,16 @@ var INLINE_LINK = /(\S+)(?:\s+([\s\S]+))?/; +/** + * @dgService linkInlineTagDef + * @description + * Process inline link tags (of the form {@link some/uri Some Title}), replacing them with HTML anchors + * @kind function + * @param {Object} url The url to match + * @param {Function} docs error message + * @return {String} The html link information + * + * @property {boolean} relativeLinks Whether we expect the links to be relative to the originating doc + */ module.exports = function linkInlineTagDef(getLinkInfo, createDocMessage) { return { name: 'link',