Florianschmidtwelzow has uploaded a new change for review.
https://gerrit.wikimedia.org/r/223528
Change subject: Create PHP docs with Doxygen instead of phpdocumentor
......................................................................
Create PHP docs with Doxygen instead of phpdocumentor
This allows us to easier publish our docs and they follow a de facto
default for MediaWiki (mediawiki/core, oojs-ui, and all other libraries
using doxgen to generate php docs).
Bug: T105134
Change-Id: Ia6b7e2c48c5459478a7ddb5de3b23e90a4ced9df
---
A Doxyfile
M composer.json
2 files changed, 37 insertions(+), 5 deletions(-)
git pull ssh://gerrit.wikimedia.org:29418/mediawiki/extensions/MobileFrontend
refs/changes/28/223528/1
diff --git a/Doxyfile b/Doxyfile
new file mode 100644
index 0000000..2a5fbdb
--- /dev/null
+++ b/Doxyfile
@@ -0,0 +1,36 @@
+# Configuration file for Doxygen
+
+PROJECT_NAME = MobileFrontend
+PROJECT_BRIEF = Mobile optimised frontend for MediaWiki
+
+OUTPUT_DIRECTORY = docs
+HTML_OUTPUT = php
+
+JAVADOC_AUTOBRIEF = YES
+QT_AUTOBRIEF = YES
+
+WARN_NO_PARAMDOC = YES
+
+INPUT = ./
+EXCLUDE_PATTERNS = */vendor/*
+EXCLUDE_PATTERNS += */docs/*
+EXCLUDE_PATTERNS += */node_modules/*
+FILE_PATTERNS = *.php
+RECURSIVE = YES
+# Requires doxygen 1.8.3+
+USE_MDFILE_AS_MAINPAGE = README.mediawiki
+
+HTML_DYNAMIC_SECTIONS = YES
+GENERATE_TREEVIEW = YES
+TREEVIEW_WIDTH = 250
+
+GENERATE_LATEX = NO
+
+HAVE_DOT = YES
+DOT_FONTNAME = Helvetica
+DOT_FONTSIZE = 10
+TEMPLATE_RELATIONS = YES
+CALL_GRAPH = NO
+CALLER_GRAPH = NO
+# Makes dot run faster. Requires graphviz >1.8.10
+DOT_MULTI_TARGETS = YES
diff --git a/composer.json b/composer.json
index 49a03cf..263ca10 100644
--- a/composer.json
+++ b/composer.json
@@ -1,16 +1,12 @@
{
"require-dev": {
"jakub-onderka/php-parallel-lint": "0.9",
- "mediawiki/mediawiki-codesniffer": "0.3.0",
- "phpdocumentor/phpdocumentor": "^2.8"
+ "mediawiki/mediawiki-codesniffer": "0.3.0"
},
"scripts": {
"test": [
"parallel-lint . --exclude vendor",
"phpcs
--standard=vendor/mediawiki/mediawiki-codesniffer/MediaWiki
--extensions=php,php5,inc --ignore=vendor -p ."
- ],
- "doc": [
- "phpdoc"
]
}
}
--
To view, visit https://gerrit.wikimedia.org/r/223528
To unsubscribe, visit https://gerrit.wikimedia.org/r/settings
Gerrit-MessageType: newchange
Gerrit-Change-Id: Ia6b7e2c48c5459478a7ddb5de3b23e90a4ced9df
Gerrit-PatchSet: 1
Gerrit-Project: mediawiki/extensions/MobileFrontend
Gerrit-Branch: master
Gerrit-Owner: Florianschmidtwelzow <[email protected]>
_______________________________________________
MediaWiki-commits mailing list
[email protected]
https://lists.wikimedia.org/mailman/listinfo/mediawiki-commits
