Edit this topic

Api documentation path mapper

: shell

: id-to-path-map

: api-documentation

: /modules/core/documentation/services/api-documentation-path-mapper.js

: https://github.com/DecentCMS/DecentCMS/blob/master/modules/core/documentation/services/api-documentation-path-mapper.js

class: ApiDocumentationPathMapper

new ApiDocumentationPathMapper()

Maps API documentation topic ids onto the relevant file, in the right module.

apiDocumentationPathMapper.mapIdToPath(root, id) ⇒ Array.<string>

Maps API documentation topic ids onto the relevant file, in the right module.

Returns: Array.<string> - The list of possible paths for a source file with JsDoc comments to be extracted.

Param Type Description
root string The content root for API documentation (anything other than 'apidocs' will be ignored).
id string The topic's id, in the form: [module-technical-name]/[source-filename-without-extension]. The file name does not include the path under the module.