mirrors/easyappointments
1
0
Fork 1
mirror of https://github.com/alextselegidis/easyappointments.git synced 2024-11-22 07:52:29 +03:00
Code Issues Projects Releases Packages Wiki Activity

Implemented the gulp doc task.

Browse source
This commit is contained in:
Alex Tselegidis 2015-12-30 23:01:30 +01:00
parent e02dec5460
commit e2109b6ceb
3 changed files with 24 additions and 21 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

20
code-doc.sh
View file

@ -1,20 +0,0 @@
#!/bin/bash
#
# Bash script for the code documentation generation.
#
rm -rf doc
mkdir doc
mkdir doc/apigen
mkdir doc/jsdoc
mkdir doc/plato
php src/application/third_party/bin/apigen generate \
-s "src/application/controllers,src/application/models,src/application/libraries" \
-d "doc/apigen" --exclude "*external*" --tree --todo --template-theme "bootstrap"
node node_modules/.bin/jsdoc "src/assets/js" -d "doc/jsdoc"
node node_modules/.bin/plato -r -d "doc/plato" "src/assets/js"

25
gulpfile.js
View file

@ -59,6 +59,29 @@ gulp.task('build', function(done) {
/**
* Generate code documentation.
*/
gulp.task('doc', function() {
gulp.task('doc', function(done) {
fs.removeSync('doc');
fs.mkdirSync('doc');
fs.mkdirSync('doc/apigen');
fs.mkdirSync('doc/jsdoc');
fs.mkdirSync('doc/plato');
var commands = [
'php rsc/apigen.phar generate ' +
'-s "src/application/controllers,src/application/models,src/application/libraries" ' +
'-d "doc/apigen" --exclude "*external*" --tree --todo --template-theme "bootstrap"',
'node node_modules/.bin/jsdoc "src/assets/js" -d "doc/jsdoc"',
'node node_modules/.bin/plato -r -d "doc/plato" "src/assets/js"'
];
commands.forEach(function(command) {
exec(command, function (err, stdout, stderr) {
console.log(stdout);
console.log(stderr);
});
});
done();
});

BIN
rsc/apigen.phar Normal file
View file

Binary file not shown.