Edit this topic

Api documentation enumerator

: shell

: api-documentation

: content-enumerator

: /modules/core/documentation/services/api-documentation-enumerator.js

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


A content enumerator that looks for API documentation extracted from source files.

Kind: global variable

documentationEnumerator.getItemEnumerator(context) ⇒ function

Gets an asynchronous enumerator for all API documentation topics.

Kind: static method of documentationEnumerator
Returns: function - The function that gets the next item. It takes a callback function as its parameter

Param Type Description
context object The context.
context.scope object The scope.
[context.idFilter] RegExp A regular expression that validates content item ids before they are read and indexed.


Looks for the next item in the store.

Kind: inner method of getItemEnumerator

Param Type Description
callback function the function that gets called when the item has been fetched. This function takes an error object and the item as its parameters. When all items have been enumerated, the callback is called without parameters.