dfb8390a42
* Adding configuration files for jsduck. * Fixing our previously undocumented code documentation to comply with jsduck specifications .. for the following modules: - mediawiki - mediawiki.Title - mediawiki.util - mediawiki.notification - mediawiki.api (and plugins thereof) - jquery.localize I've choose these to show as many different examples for different types of modules and methods that we encounter in our code base. Hopefully with this as a start it will be easy for other people to extend the documentation for most (if not, all) other modules we have in MediaWiki core. Change-Id: Ieb8c5d2d2cb4672f1d6abc3f865c6fb1470d8feb
19 lines
575 B
Makefile
19 lines
575 B
Makefile
help:
|
|
@echo "Run 'make test' to run the parser tests."
|
|
@echo "Run 'make doc' to run the doxygen generation."
|
|
@echo "Run 'make man' to run the doxygen generation with man pages."
|
|
|
|
test:
|
|
php tests/parserTests.php --quiet
|
|
|
|
doc:
|
|
php mwdocgen.php --all
|
|
./mwjsduck-gen
|
|
@echo 'PHP documentation (by Doxygen) in ./docs/html/'
|
|
@echo 'JS documentation (by JSDuck) in ./docs/js/'
|
|
|
|
man:
|
|
php mwdocgen.php --all --generate-man
|
|
@echo 'Doc generation done. Look at ./docs/html/ and ./docs/man'
|
|
@echo 'You might want to update your MANPATH currently:'
|
|
@echo 'MANPATH: $(MANPATH)'
|