3 * Filter for PHP source code that allows Doxygen to understand it better.
5 * This CLI script is intended to be configured as the INPUT_FILTER
6 * script in a Doxyfile, e.g. like "php mwdoc-filter.php".
8 * Permission is hereby granted, free of charge, to any person obtaining
9 * a copy of this software and associated documentation files (the "Software"),
10 * to deal in the Software without restriction, including without limitation
11 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
12 * and/or sell copies of the Software, and to permit persons to whom the
13 * Software is furnished to do so, subject to the following conditions:
15 * The above copyright notice and this permission notice shall be included
16 * in all copies or substantial portions of the Software.
18 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
19 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
20 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
21 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
22 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
23 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
24 * DEALINGS IN THE SOFTWARE.
27 // Warning: Converting this to a Maintenance script may reduce performance.
28 if ( PHP_SAPI
!= 'cli' && PHP_SAPI
!= 'phpdbg' ) {
29 die( "This filter can only be run from the command line.\n" );
32 require_once __DIR__
. '/includes/MWDoxygenFilter.php';
34 $source = file_get_contents( $argv[1] );
35 echo MWDoxygenFilter
::filter( $source );