mirror of
https://github.com/phpbb/phpbb.git
synced 2025-06-28 14:18:52 +00:00
[task/sami] Replace phpdoctor with sami.
PHPBB3-12495
This commit is contained in:
Andreas Fischer
parent
b32f91b9c6
commit
f08f283143
3 changed files with 51 additions and 153 deletions
|
|
@ -74,14 +74,8 @@
|
||||||
</target>
|
</target>
|
||||||
|
|
||||||
<target name="docs">
|
<target name="docs">
|
||||||
<!-- only works if you setup phpdoctor:
|
<exec dir="."
|
||||||
git clone https://github.com/peej/phpdoctor.git
|
command="phpBB/vendor/bin/sami.php update build/sami.conf.php"
|
||||||
and then create an executable phpdoctor in your path containing
|
|
||||||
#!/bin/sh
|
|
||||||
php -f /path/to/phpdoctor/phpdoc.php $@
|
|
||||||
-->
|
|
||||||
<exec dir="build"
|
|
||||||
command="phpdoctor phpdoc-phpbb.ini"
|
|
||||||
passthru="true" />
|
passthru="true" />
|
||||||
</target>
|
</target>
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -1,145 +0,0 @@
|
||||||
; Default configuration file for PHPDoctor
|
|
||||||
|
|
||||||
; This config file will cause PHPDoctor to generate API documentation of
|
|
||||||
; itself.
|
|
||||||
|
|
||||||
|
|
||||||
; PHPDoctor settings
|
|
||||||
; -----------------------------------------------------------------------------
|
|
||||||
|
|
||||||
; Names of files to parse. This can be a single filename, or a comma separated
|
|
||||||
; list of filenames. Wildcards are allowed.
|
|
||||||
|
|
||||||
files = "*.php"
|
|
||||||
|
|
||||||
; Names of files or directories to ignore. This can be a single filename, or a
|
|
||||||
; comma separated list of filenames. Wildcards are NOT allowed.
|
|
||||||
|
|
||||||
;ignore = "CVS, .svn, .git, _compiled"
|
|
||||||
ignore = templates_c/,*HTML/default/*,spec/,*config.php*,*CVS/,test_chora.php,testupdate/,cache/,store/,*proSilver/,develop/,includes/utf/data/,includes/captcha/fonts/,install/update/,install/update.new/,files/,*phpinfo.php*,*update_script.php*,*upgrade.php*,*convert.php*,install/converter/,language/de/,script/,*swatch.php*,*test.php*,*test2.php*,*install.php*,*functions_diff.php*,*acp_update.php*,acm_xcache.php
|
|
||||||
|
|
||||||
; The directory to look for files in, if not used the PHPDoctor will look in
|
|
||||||
; the current directory (the directory it is run from).
|
|
||||||
|
|
||||||
source_path = "../phpBB/"
|
|
||||||
|
|
||||||
; If you do not want PHPDoctor to look in each sub directory for files
|
|
||||||
; uncomment this line.
|
|
||||||
|
|
||||||
;subdirs = off
|
|
||||||
|
|
||||||
; Set how loud PHPDoctor is as it runs. Quiet mode suppresses all output other
|
|
||||||
; than warnings and errors. Verbose mode outputs additional messages during
|
|
||||||
; execution.
|
|
||||||
|
|
||||||
quiet = on
|
|
||||||
;verbose = on
|
|
||||||
|
|
||||||
; Select the doclet to use for generating output.
|
|
||||||
|
|
||||||
doclet = standard
|
|
||||||
;doclet = debug
|
|
||||||
|
|
||||||
; The directory to find the doclet in. Doclets control the HTML output of
|
|
||||||
; phpDoctor and can be modified to suit your needs. They are expected to be
|
|
||||||
; in a directory named after themselves at the location given.
|
|
||||||
|
|
||||||
;doclet_path = ./doclets
|
|
||||||
|
|
||||||
; Select the formatter to use for generating output.
|
|
||||||
|
|
||||||
;formatter = htmlStandardFormatter
|
|
||||||
|
|
||||||
; The directory to find the formatter in. Formatters convert textual markup
|
|
||||||
; for use by the doclet.
|
|
||||||
|
|
||||||
;formatter_path = ./formatters
|
|
||||||
|
|
||||||
; The directory to find taglets in. Taglets allow you to make PHPDoctor handle
|
|
||||||
; new tags and to alter the behavour of existing tags and their output.
|
|
||||||
|
|
||||||
;taglet_path = ./taglets
|
|
||||||
|
|
||||||
; If the code you are parsing does not use package tags or not all elements
|
|
||||||
; have package tags, use this setting to place unbound elements into a
|
|
||||||
; particular package.
|
|
||||||
|
|
||||||
default_package = "phpBB"
|
|
||||||
|
|
||||||
use_class_path_as_package = off
|
|
||||||
|
|
||||||
ignore_package_tags = off
|
|
||||||
|
|
||||||
; Specifies the name of a HTML file containing text for the overview
|
|
||||||
; documentation to be placed on the overview page. The path is relative to
|
|
||||||
; "source_path" unless an absolute path is given.
|
|
||||||
|
|
||||||
overview = ../README.md
|
|
||||||
|
|
||||||
; Package comments will be looked for in a file named package.html in the same
|
|
||||||
; directory as the first source file parsed in that package or in the directory
|
|
||||||
; given below. If package comments are placed in the directory given below then
|
|
||||||
; they should be named "<packageName>.html".
|
|
||||||
|
|
||||||
package_comment_dir = ./
|
|
||||||
|
|
||||||
; Parse out global variables and/or global constants?
|
|
||||||
|
|
||||||
;globals = off
|
|
||||||
;constants = off
|
|
||||||
|
|
||||||
; Generate documentation for all class members
|
|
||||||
|
|
||||||
;private = on
|
|
||||||
|
|
||||||
; Generate documentation for public and protected class members
|
|
||||||
|
|
||||||
;protected = on
|
|
||||||
|
|
||||||
; Generate documentation for only public class members
|
|
||||||
|
|
||||||
;public = on
|
|
||||||
|
|
||||||
; Use the PEAR compatible handling of the docblock first sentence
|
|
||||||
|
|
||||||
;pear_compat = on
|
|
||||||
|
|
||||||
; Standard doclet settings
|
|
||||||
; -----------------------------------------------------------------------------
|
|
||||||
|
|
||||||
; The directory to place generated documentation in. If the given path is
|
|
||||||
; relative to it will be relative to "source_path".
|
|
||||||
|
|
||||||
d = "../build/api/"
|
|
||||||
|
|
||||||
; Specifies the title to be placed in the HTML <title> tag.
|
|
||||||
|
|
||||||
windowtitle = "phpBB3"
|
|
||||||
|
|
||||||
; Specifies the title to be placed near the top of the overview summary file.
|
|
||||||
|
|
||||||
doctitle = "phpBB3 Sourcecode Documentation"
|
|
||||||
|
|
||||||
; Specifies the header text to be placed at the top of each output file. The
|
|
||||||
; header will be placed to the right of the upper navigation bar.
|
|
||||||
|
|
||||||
header = "phpBB3"
|
|
||||||
|
|
||||||
; Specifies the footer text to be placed at the bottom of each output file. The
|
|
||||||
; footer will be placed to the right of the lower navigation bar.
|
|
||||||
|
|
||||||
footer = "phpBB3"
|
|
||||||
|
|
||||||
; Specifies the text to be placed at the bottom of each output file. The text
|
|
||||||
; will be placed at the bottom of the page, below the lower navigation bar.
|
|
||||||
|
|
||||||
;bottom = "This document was generated by <a href="http://peej.github.com/phpdoctor/">PHPDoctor: The PHP Documentation Creator</a>"
|
|
||||||
|
|
||||||
; Create a class tree?
|
|
||||||
|
|
||||||
;tree = off
|
|
||||||
|
|
||||||
; Use GeSHi to include formatted source files in the documentation. PHPDoctor will look in the current doclet directory for a /geshi subdirectory. Unpack the GeSHi archive from http://qbnz.com/highlighter to get this directory - it will contain a php script and a subdirectory with formatting files.
|
|
||||||
|
|
||||||
include_source = off
|
|
||||||
|
|
||||||
49
build/sami.conf.php
Normal file
49
build/sami.conf.php
Normal file
|
|
@ -0,0 +1,49 @@
|
||||||
|
<?php
|
||||||
|
/**
|
||||||
|
* @copyright (c) 2014 phpBB Group
|
||||||
|
* @license http://opensource.org/licenses/gpl-2.0.php GNU General Public License v2
|
||||||
|
*/
|
||||||
|
|
||||||
|
// Prevent 'Class "acm" does not exist.' exception on removeClass().
|
||||||
|
class PhpbbArrayStore extends Sami\Store\ArrayStore
|
||||||
|
{
|
||||||
|
public function removeClass(Sami\Project $project, $name)
|
||||||
|
{
|
||||||
|
unset($this->classes[$name]);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
$iterator = Symfony\Component\Finder\Finder::create()
|
||||||
|
->files()
|
||||||
|
->name('*.php')
|
||||||
|
->in(__DIR__ . '/../phpBB/')
|
||||||
|
->notPath('#^cache/#')
|
||||||
|
->notPath('#^vendor/#')
|
||||||
|
->notPath('#^develop/#')
|
||||||
|
->notPath('data')
|
||||||
|
;
|
||||||
|
|
||||||
|
$versions = Sami\Version\GitVersionCollection::create(__DIR__ . '/../')
|
||||||
|
/*
|
||||||
|
This would be nice, but currently causes various problems that need
|
||||||
|
debugging.
|
||||||
|
->addFromTags('release-3.0.*')
|
||||||
|
->add('develop-olympus', '3.0-next (olympus)')
|
||||||
|
->addFromTags('release-3.1.*')
|
||||||
|
->add('develop-ascraeus', '3.1-next (ascraeus)')
|
||||||
|
->add('develop')
|
||||||
|
*/
|
||||||
|
->add('develop-olympus')
|
||||||
|
->add('develop-ascraeus')
|
||||||
|
;
|
||||||
|
|
||||||
|
return new Sami\Sami($iterator, array(
|
||||||
|
'theme' => 'enhanced',
|
||||||
|
'versions' => $versions,
|
||||||
|
'title' => 'phpBB API Documentation',
|
||||||
|
'build_dir' => __DIR__.'/api/output/%version%',
|
||||||
|
'cache_dir' => __DIR__.'/api/cache/%version%',
|
||||||
|
'default_opened_level' => 2,
|
||||||
|
// Do not use JsonStore. See https://github.com/fabpot/Sami/issues/79
|
||||||
|
'store' => new PhpbbArrayStore,
|
||||||
|
));
|
||||||
Loading…
Add table
Reference in a new issue