summaryrefslogtreecommitdiff
path: root/docu/README
diff options
context:
space:
mode:
authorLaria Carolin Chabowski <laria@laria.me>2020-05-01 17:33:13 +0200
committerLaria Carolin Chabowski <laria@laria.me>2020-05-01 17:33:13 +0200
commit7449faaa76a5b4008fd51a6562cca2e0a852ea6b (patch)
tree9e6bc34afe9e4e7d49b1a26f0b67485869b0a9de /docu/README
parentb0c9a4aeb61aff8a8fa60746cd566e6dbe05a3b5 (diff)
downloadste-7449faaa76a5b4008fd51a6562cca2e0a852ea6b.tar.gz
ste-7449faaa76a5b4008fd51a6562cca2e0a852ea6b.tar.bz2
ste-7449faaa76a5b4008fd51a6562cca2e0a852ea6b.zip
Clean up code and improve documentation
This switches the code documentation genarator (we're now using phpdoc instead of NaturalDoc). Also various small code cleanup tasks: - Remove unused code - Get rid of `and` / `or`, we're using `&&` / `||` now - Adding missing return values - Helping PhpStorm to detect some dynamically called functions (mark_builtin_callable in Transcompiler) - Reword transcompiling => compiling in documentation
Diffstat (limited to 'docu/README')
-rw-r--r--docu/README5
1 files changed, 2 insertions, 3 deletions
diff --git a/docu/README b/docu/README
index dc3ec47..7802509 100644
--- a/docu/README
+++ b/docu/README
@@ -1,4 +1,3 @@
-Run ../mkdoku.sh to generate the documentation of the PHP source.
-You will need NaturalDocs[1] for that.
+Run `composer install` to install phpdoc.
-[1]: http://www.naturaldocs.org/ \ No newline at end of file
+Run ../mkdoku.sh to generate the documentation of the PHP source using phpdoc.