Edit this topic

Jsdoc content file parser

: shell

: api-documentation

: content-file-parser

: /modules/core/documentation/services/jsdoc-content-file-parser.js

: https://github.com/DecentCMS/DecentCMS/blob/master/modules/core/documentation/services/jsdoc-content-file-parser.js


A content store that uses the JsDoc inside source files.

Kind: global variable

jsDocContentFileParser.parse(context, nextStore)

Parses a source file for JsDoc comments, and dynamically builds a content item from it, with a Markdown body part, and the service name as the title, de-dashed. The scope, service name, and feature are added as properties scope, service, and feature. The content type is "api-documentation".

Kind: static method of jsDocContentFileParser

Param Type Description
context object The context.
context.scope object The scope.
context.path string The path to the file to parse.
context.data string The text contents of the file to parse.
[context.item] object The parsed content item if it was found and successfully parsed.
nextStore function The callback.