@doop/docs

@DOOP/Docs

Doop documentation module

This module generally lives inside a build script.

/**
* Scan files for inline comments and build documentation 
*/
let gulp = require('gulp');
let {documenter} = require('@doop/docs');

gulp.task('build.vue', ['load:app', 'load:app.db', 'load:app.git'], ()=>
	documenter({
		log: gulp.log, // Fancy logging output
	})
);

API

This module exports only one sub-module currently, the documenter function.

Documenter(options)

Scan project for inline documentation and process placing resulting files in the dist/docs directory within the parent Doop project.

This function expects the Doop global app to be available and it will use it for pathing, config information.

Options:

Usage

• @returns {Object} where a collection is available will automagically be replaced with @returns {ModelName}
• @returns {ModelName} will create an application/json response with schema properties matching that of the Mongo collection.

Predefined Response Types

These types may be used in @returns {Type} and allow association of a response with a content-type and schema.

NOTES:

• https://github.com/Mermade/widdershins#options
• https://github.com/Mermade/shins