diff --git a/.gitignore b/.gitignore index 8b5367d2..5fc30c07 100644 --- a/.gitignore +++ b/.gitignore @@ -1,2 +1,3 @@ +doc src/config.php src/application/logs/* \ No newline at end of file diff --git a/code-doc.sh b/code-doc.sh new file mode 100644 index 00000000..d4af0fd1 --- /dev/null +++ b/code-doc.sh @@ -0,0 +1,14 @@ +#!/bin/bash + +# +# Bash script for the generation of code documentation. +# + +rm -rf doc + +mkdir doc +mkdir doc/apigen + +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" \ No newline at end of file diff --git a/rsc/code-doc.sh b/rsc/code-doc.sh deleted file mode 100644 index 1cdadf61..00000000 --- a/rsc/code-doc.sh +++ /dev/null @@ -1,9 +0,0 @@ -#!bin/bash - -# Generate PHP Documentation. -rm -rf "../doc/code/php/*" -php apigen.phar generate -s "../src/application/controllers,../src/application/models,../src/application/libraries" -d "../doc/code/php" --exclude "*external*" --tree --todo --template-theme "bootstrap" - -# Generate JS Documentation (requires jsdoc in nodejs environment). -rm -rf "../doc/code/js/*" -jsdoc "../src/assets/js" -d "../doc/code/js" \ No newline at end of file