Merge branch 'master' into traits

peej · Mar 10, 2013 · 83f4215 · 83f4215
2 parents 2f3857b + f45ea7f
commit 83f4215
Show file tree

Hide file tree

Showing 21 changed files with 29 additions and 30 deletions.
diff --git a/composer.json b/composer.json
@@ -3,7 +3,7 @@
     "description": "PHPDoctor: The PHP Documentation Creator",
     "keywords": ["documentation", "api"],
     "homepage": "http://peej.github.com/phpdoctor",
-    "license": "MIT",
+    "license": "GPL-2.0+",
     "authors": [
         {
             "name": "Paul James",
@@ -15,5 +15,6 @@
     },
     "require-dev": {
         "lastcraft/simpletest": "1.1.*"
-    }
+    },
+    "bin": ["phpdoc"]
 }
diff --git a/doclets/github/classWriter.php b/doclets/github/classWriter.php
@@ -22,7 +22,7 @@
 /** This generates the HTML API documentation for each individual interface
  * and class.
  *
- * @package PHPDoctor\Doclets\Standard
+ * @package PHPDoctor\Doclets\Github
  */
 class ClassWriter extends MDWriter {
 

diff --git a/doclets/github/deprecatedWriter.php b/doclets/github/deprecatedWriter.php
@@ -21,7 +21,7 @@
 
 /** This generates the deprecated elements index.
  *
- * @package PHPDoctor\Doclets\Standard
+ * @package PHPDoctor\Doclets\Github
  */
 class DeprecatedWriter extends MDWriter {
 

diff --git a/doclets/github/functionWriter.php b/doclets/github/functionWriter.php
@@ -21,7 +21,7 @@
 
 /** This generates the HTML API documentation for each global function.
  *
- * @package PHPDoctor\Doclets\Standard
+ * @package PHPDoctor\Doclets\Github
  */
 class FunctionWriter extends MDWriter {
 

diff --git a/doclets/github/github.php b/doclets/github/github.php
@@ -32,7 +32,7 @@
 /** The standard doclet. This doclet generates HTML output similar to that
  * produced by the Javadoc standard doclet.
  *
- * @package PHPDoctor\Doclets\Standard
+ * @package PHPDoctor\Doclets\Github
  */
 class Github extends Doclet {
 

diff --git a/doclets/github/globalWriter.php b/doclets/github/globalWriter.php
@@ -21,7 +21,7 @@
 
 /** This generates the HTML API documentation for each global variable.
  *
- * @package PHPDoctor\Doclets\Standard
+ * @package PHPDoctor\Doclets\Github
  */
 class GlobalWriter extends MDWriter {
 

diff --git a/doclets/github/indexWriter.php b/doclets/github/indexWriter.php
@@ -21,7 +21,7 @@
 
 /** This generates the element index.
  *
- * @package PHPDoctor\Doclets\Standard
+ * @package PHPDoctor\Doclets\Github
  */
 class IndexWriter extends MDWriter {
 

diff --git a/doclets/github/packageWriter.php b/doclets/github/packageWriter.php
@@ -22,7 +22,7 @@
 /** This generates the README.md files that list the interfaces and
  * classes for a given package.
  *
- * @package PHPDoctor\Doclets\Standard
+ * @package PHPDoctor\Doclets\Github
  */
 class PackageWriter extends MDWriter {
 

diff --git a/doclets/github/todoWriter.php b/doclets/github/todoWriter.php
@@ -21,7 +21,7 @@
 
 /** This generates the todo elements index.
  *
- * @package PHPDoctor\Doclets\Standard
+ * @package PHPDoctor\Doclets\Github
  */
 class TodoWriter extends MDWriter {
 

diff --git a/doclets/github_wiki/classWriter.php b/doclets/github_wiki/classWriter.php
@@ -22,7 +22,7 @@
 /** This generates the HTML API documentation for each individual interface
  * and class.
  *
- * @package PHPDoctor\Doclets\Standard
+ * @package PHPDoctor\Doclets\GithubWiki
  */
 class ClassWriter extends MDWriter {
 

diff --git a/doclets/github_wiki/deprecatedWriter.php b/doclets/github_wiki/deprecatedWriter.php
@@ -21,7 +21,7 @@
 
 /** This generates the deprecated elements index.
  *
- * @package PHPDoctor\Doclets\Standard
+ * @package PHPDoctor\Doclets\GithubWiki
  */
 class DeprecatedWriter extends MDWriter {
 

diff --git a/doclets/github_wiki/functionWriter.php b/doclets/github_wiki/functionWriter.php
@@ -21,7 +21,7 @@
 
 /** This generates the HTML API documentation for each global function.
  *
- * @package PHPDoctor\Doclets\Standard
+ * @package PHPDoctor\Doclets\GithubWiki
  */
 class FunctionWriter extends MDWriter {
 

diff --git a/doclets/github_wiki/github_wiki.php b/doclets/github_wiki/github_wiki.php
@@ -32,7 +32,7 @@
 /** The standard doclet. This doclet generates HTML output similar to that
  * produced by the Javadoc standard doclet.
  *
- * @package PHPDoctor\Doclets\Standard
+ * @package PHPDoctor\Doclets\GithubWiki
  */
 class Github_wiki extends Doclet {
 

diff --git a/doclets/github_wiki/globalWriter.php b/doclets/github_wiki/globalWriter.php
@@ -21,7 +21,7 @@
 
 /** This generates the HTML API documentation for each global variable.
  *
- * @package PHPDoctor\Doclets\Standard
+ * @package PHPDoctor\Doclets\GithubWiki
  */
 class GlobalWriter extends MDWriter {
 

diff --git a/doclets/github_wiki/indexWriter.php b/doclets/github_wiki/indexWriter.php
@@ -21,7 +21,7 @@
 
 /** This generates the element index.
  *
- * @package PHPDoctor\Doclets\Standard
+ * @package PHPDoctor\Doclets\GithubWiki
  */
 class IndexWriter extends MDWriter {
 

diff --git a/doclets/github_wiki/mdWriter.php b/doclets/github_wiki/mdWriter.php
@@ -22,7 +22,7 @@
 /** This generates the index.md file used for presenting the frame-formated
  * "cover page" of the API documentation.
  *
- * @package PHPDoctor\Doclets\Github
+ * @package PHPDoctor\Doclets\GithubWiki
  * @todo Refactor this class to MDWriter
  */
 class MDWriter {

diff --git a/doclets/github_wiki/packageWriter.php b/doclets/github_wiki/packageWriter.php
@@ -22,7 +22,7 @@
 /** This generates the README.md files that list the interfaces and
  * classes for a given package.
  *
- * @package PHPDoctor\Doclets\Standard
+ * @package PHPDoctor\Doclets\GithubWiki
  */
 class PackageWriter extends MDWriter {
 

diff --git a/doclets/github_wiki/todoWriter.php b/doclets/github_wiki/todoWriter.php
@@ -21,7 +21,7 @@
 
 /** This generates the todo elements index.
  *
- * @package PHPDoctor\Doclets\Standard
+ * @package PHPDoctor\Doclets\GithubWiki
  */
 class TodoWriter extends MDWriter {
 

diff --git a/phpdoc b/phpdoc
@@ -0,0 +1,2 @@
+#!/usr/bin/env php
+<?php include 'phpdoc.php';
diff --git a/phpdoc.php b/phpdoc.php
@@ -26,8 +26,8 @@
     die('This program must be run from the command line using the CLI version of PHP');
 
 // check we are using the correct version of PHP
-} elseif (!defined('T_COMMENT') || !extension_loaded('tokenizer') || version_compare(phpversion(), '4.3.0', '<')) {
-    error('You need PHP version 4.3.0 or greater with the "tokenizer" extension to run this script, please upgrade');
+} elseif (!defined('T_COMMENT') || !extension_loaded('tokenizer') || version_compare(phpversion(), '5', '<')) {
+    error('You need PHP version 5 or greater with the "tokenizer" extension to run this script, please upgrade');
     exit;
 }
 
@@ -41,19 +41,15 @@
         $argv[1] = $_ENV['PHPDoctor'];
     } elseif (is_file(getcwd().'/phpdoctor.ini')) {
         $argv[1] = getcwd().'/phpdoctor.ini';
-    } elseif (is_file('default.ini')) {
-        phpDoctor::warning('Using default config file "default.ini"');
-        $argv[1] = 'default.ini';
+    } elseif (is_file(dirname(__FILE__).'/phpdoctor.ini')) {
+        $argv[1] = dirname(__FILE__).'/phpdoctor.ini';
     } else {
-        phpDoctor::error('Usage: phpdoc.php [config_file]');
-        exit;
+        die("Usage: phpdoc [config_file]\n");
     }
 }
 
-$phpdoc =& new phpDoctor($argv[1]);
+$phpdoc = new phpDoctor($argv[1]);
 
 $rootDoc =& $phpdoc->parse();
 
 $phpdoc->execute($rootDoc);
-
-?>
diff --git a/default.ini → phpdoctor.ini b/default.ini → phpdoctor.ini
@@ -15,7 +15,7 @@ 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 = "CVS, .svn, .git, _compiled, vendor"
 
 ; The directory to look for files in, if not used the PHPDoctor will look in
 ; the current directory (the directory it is run from).