Merge branch '3.3.x'

.travis.yml

@@ -47,7 +47,7 @@ before_script:
 
 script:
   - travis/phing-sniff.sh $DB $TRAVIS_PHP_VERSION $NOTESTS
-  - travis/check-sami-parse-errors.sh $DB $TRAVIS_PHP_VERSION $NOTESTS
+  - travis/check-doctum-parse-errors.sh $DB $TRAVIS_PHP_VERSION $NOTESTS
   - travis/check-image-icc-profiles.sh $DB $TRAVIS_PHP_VERSION $NOTESTS
   - travis/check-executable-files.sh $DB $TRAVIS_PHP_VERSION $NOTESTS ./
   - travis/check-stylesheet.sh $NOTESTS

build/build.xml

@@ -128,13 +128,13 @@
 	<!-- Builds docs for current branch into build/api/output/master -->
 	<target name="docs">
 		<exec dir="."
-			command="phpBB/vendor/bin/sami.php update build/sami-checkout.conf.php"
+			command="php doctum.phar update build/doctum-checkout.conf.php"
 			passthru="true" />
 	</target>
 	<!-- Builds docs for multiple branches/tags into build/api/output/$branch -->
 	<target name="docs-all">
 		<exec dir="."
-			command="phpBB/vendor/bin/sami.php update build/sami-all.conf.php"
+			command="php doctum.phar update build/doctum-all.conf.php"
 			passthru="true" />
 	</target>
 

build/sami-all.conf.php → build/doctum-all.conf.php

@@ -11,9 +11,9 @@
 *
 */
 
-require __DIR__ . '/sami-checkout.conf.php';
+require __DIR__ . '/doctum-checkout.conf.php';
 
-$config['versions'] = Sami\Version\GitVersionCollection::create(__DIR__ . '/../')
+$config['versions'] = Doctum\Version\GitVersionCollection::create(__DIR__ . '/../')
 	/*
 	This would be nice, but currently causes various problems that need
 	debugging.
@@ -30,4 +30,4 @@
 	->add('master')
 ;
 
-return new Sami\Sami($iterator, $config);
+return new Doctum\Doctum($iterator, $config);

build/doctum-checkout.conf.php

@@ -0,0 +1,31 @@
+<?php
+/**
+*
+* This file is part of the phpBB Forum Software package.
+*
+* @copyright (c) phpBB Limited <https://www.phpbb.com>
+* @license GNU General Public License, version 2 (GPL-2.0)
+*
+* For full copyright and license information, please see
+* the docs/CREDITS.txt file.
+*
+*/
+
+$iterator = Symfony\Component\Finder\Finder::create()
+	->files()
+	->name('*.php')
+	->in(__DIR__ . '/../phpBB/')
+	->notPath('#^cache/#')
+	->notPath('#^develop/#')
+	->notPath('#^ext/#')
+	->notPath('#^vendor/#')
+	->notPath('data');
+
+// This variable will be used and changed in doctum-all.conf.php
+$config = [
+	'title'                => 'phpBB API Documentation',
+	'build_dir'            => __DIR__ . '/api/output/%version%',
+	'cache_dir'            => __DIR__ . '/api/cache/%version%',
+];
+
+return new Doctum\Doctum($iterator, $config);

phpBB/composer.json

@@ -61,8 +61,7 @@
 		"squizlabs/php_codesniffer": "~3.4",
 		"symfony/browser-kit": "~3.4",
 		"symfony/css-selector": "~3.4",
-		"symfony/dom-crawler": "~3.4",
-		"sami/sami": "^4.1"
+		"symfony/dom-crawler": "~3.4"
 	},
 	"extra": {
 		"branch-alias": {