pulsar-edit/pulsar
1
1
Fork 0
mirror of https://github.com/pulsar-edit/pulsar.git synced 2024-09-20 15:37:46 +03:00
Code Issues Packages Projects Releases Wiki Activity

Generate API docs from js sources

Browse Source
This commit is contained in:
Max Brunsfeld 2016-08-01 15:57:18 -07:00
parent 3fd275a7f6
commit 2500d59bce
2 changed files with 12 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
build/package.json
View File

@ -30,6 +30,7 @@
"grunt-peg": "~1.1.0",
"grunt-shell": "~0.3.1",
"grunt-standard": "^2.0.0",
"joanna": "0.0.3",
"legal-eagle": "~0.13.0",
"minidump": "~0.9",
"npm": "3.10.5",

13
build/tasks/docs-task.coffee
View File

@ -4,6 +4,7 @@ fs = require 'fs-plus'
_ = require 'underscore-plus'
donna = require 'donna'
joanna = require 'joanna'
tello = require 'tello'
module.exports = (grunt) ->
@ -30,8 +31,16 @@ module.exports = (grunt) ->
grunt.registerTask 'build-docs', 'Builds the API docs in src', ->
docsOutputDir = grunt.config.get('docsOutputDir')
metadata = donna.generateMetadata(['.'])
api = tello.digest(metadata)
[coffeeMetadata] = donna.generateMetadata(['.'])
jsMetadata = joanna('.')
metadata = {
repository: coffeeMetadata.repository,
version: coffeeMetadata.version,
files: Object.assign(coffeeMetadata.files, jsMetadata.files)
}
api = tello.digest([metadata])
_.extend(api.classes, getClassesToInclude())
api.classes = sortClasses(api.classes)