Skip to content

Latest commit

 

History

History
77 lines (55 loc) · 2.11 KB

JSDOC.md

File metadata and controls

77 lines (55 loc) · 2.11 KB

angular-jsdoc

Install jsdoc and angular-jsdoc

sudo npm install -g jsdoc angular-jsdoc --save-dev 
sudo nano /usr/local/lib/node_modules/angular-jsdoc/common/conf.json  
# change relative paths to these
    #"/usr/local/lib/node_modules/jsdoc/plugins/markdown",  
    #"/usr/local/lib/node_modules/angular-jsdoc/common/plugins/ngdoc"

USE

jsdoc example.js -t /usr/local/lib/node_modules/angular-jsdoc/angular-template -c /usr/local/lib/node_modules/angular-jsdoc/common/conf.json

EXAMPLES

https://rawgit.com/allenhwkim/angular-jsdoc/master/angular-template/docs/ngmap.MapController.html

automate with grunt

http://hashbang.nl/angular/2015/02/10/simple-and-clear-angular-application-documentation-using-angular-jsdoc/

Automator

creadoc.sh

#!/bin/bash

# LLAMADA  =>  
#  $1 =>  path completo al directorio con el /js
#  $2 =>  directorio de salida dentro de __DOCS
#  ./creadoc.sh '/Users/manol/Development/Monaca/kuentemobile/kuenteMobile/www/js/ *.js' 'kuentemobile'     

# VERSION 1
# cd ./$2
# jsdoc $1 -t /usr/local/lib/node_modules/angular-jsdoc/angular-template -c /usr/local/lib/node_modules/angular-jsdoc/common/conf.json
# cd ../
# open ./$2/out



# VERSION 2
# Nombre del directorio de salida en __DOCS
app=GestorDocumental
# Path de los ficheros js			
camino=/Users/manol/Development/DreamFactory/GestorDocumental/app/scripts
## declare an array variable
declare -a subfolders=("/" "/controllers/" "/directives/" "/filters/" "/services/")


# dependenden de donde esta instalado jsdoc
template='-t /usr/local/lib/node_modules/angular-jsdoc/angular-template'
config='-c /usr/local/lib/node_modules/angular-jsdoc/common/conf.json'

cd /Users/manol/Development/__DOCS
mkdir -p ${app}
cd ./${app}


# recorre todos los subfolders
for i in "${subfolders[@]}"
do
   jsdoc ${camino}$i *.js ${template} ${config}
done




# ABRE EL PROYECTO EN FINDER
cd ../
open ./${app}/out

automator -> nombreapp

cd /Users/manol/Development/__DOCS/
./creadoc.sh '/Users/manol/Development/Monaca/kuentemobile/kuenteMobile/www/js/ *.js' 'kuentemobile'