Improve phpDocs class docs

picocms · May 23, 2016 · 94279c5 · 94279c5
1 parent 79bb543
commit 94279c5
Show file tree

Hide file tree

Showing 9 changed files with 13 additions and 11 deletions.
diff --git a/config/config.php.template b/config/config.php.template
@@ -12,7 +12,7 @@
  *
  * @author  Gilbert Pellegrom
  * @link    http://picocms.org
- * @license http://opensource.org/licenses/MIT
+ * @license http://opensource.org/licenses/MIT The MIT License
  * @version 1.0
  */
 

diff --git a/lib/AbstractPicoPlugin.php b/lib/AbstractPicoPlugin.php
@@ -7,7 +7,7 @@
  *
  * @author  Daniel Rudolf
  * @link    http://picocms.org
- * @license http://opensource.org/licenses/MIT
+ * @license http://opensource.org/licenses/MIT The MIT License
  * @version 1.0
  */
 abstract class AbstractPicoPlugin implements PicoPluginInterface

diff --git a/lib/Pico.php b/lib/Pico.php
@@ -4,6 +4,7 @@
  * Pico
  *
  * Pico is a stupidly simple, blazing fast, flat file CMS.
+ *
  * - Stupidly Simple: Pico makes creating and maintaining a
  *   website as simple as editing text files.
  * - Blazing Fast: Pico is seriously lightweight and doesn't
@@ -16,12 +17,13 @@
  *   for powerful and flexible themes.
  * - Open Source: Pico is completely free and open source,
  *   released under the MIT license.
+ *
  * See <http://picocms.org/> for more info.
  *
  * @author  Gilbert Pellegrom
  * @author  Daniel Rudolf
- * @link    <http://picocms.org>
- * @license The MIT License <http://opensource.org/licenses/MIT>
+ * @link    http://picocms.org
+ * @license http://opensource.org/licenses/MIT The MIT License
  * @version 1.0
  */
 class Pico
@@ -760,7 +762,7 @@ public function getMetaHeaders()
      * for users and pure (!) theme developers ONLY.
      *
      * @see    Pico::getFileMeta()
-     * @see    <http://symfony.com/doc/current/components/yaml/introduction.html>
+     * @see    http://symfony.com/doc/current/components/yaml/introduction.html
      * @param  string   $rawContent the raw file contents
      * @param  string[] $headers    known meta headers
      * @return array                parsed meta data

diff --git a/lib/PicoPluginInterface.php b/lib/PicoPluginInterface.php
@@ -22,7 +22,7 @@
  *
  * @author  Daniel Rudolf
  * @link    http://picocms.org
- * @license http://opensource.org/licenses/MIT
+ * @license http://opensource.org/licenses/MIT The MIT License
  * @version 1.0
  */
 interface PicoPluginInterface

diff --git a/lib/PicoTwigExtension.php b/lib/PicoTwigExtension.php
@@ -5,7 +5,7 @@
  *
  * @author  Daniel Rudolf
  * @link    http://picocms.org
- * @license http://opensource.org/licenses/MIT
+ * @license http://opensource.org/licenses/MIT The MIT License
  * @version 1.0
  */
 class PicoTwigExtension extends Twig_Extension

diff --git a/plugins/00-PicoDeprecated.php b/plugins/00-PicoDeprecated.php
@@ -38,7 +38,7 @@
  *
  * @author  Daniel Rudolf
  * @link    http://picocms.org
- * @license http://opensource.org/licenses/MIT
+ * @license http://opensource.org/licenses/MIT The MIT License
  * @version 1.0
  */
 class PicoDeprecated extends AbstractPicoPlugin

diff --git a/plugins/01-PicoParsePagesContent.php b/plugins/01-PicoParsePagesContent.php
@@ -13,7 +13,7 @@
  *
  * @author  Daniel Rudolf
  * @link    http://picocms.org
- * @license http://opensource.org/licenses/MIT
+ * @license http://opensource.org/licenses/MIT The MIT License
  * @version 1.0
  */
 class PicoParsePagesContent extends AbstractPicoPlugin

diff --git a/plugins/02-PicoExcerpt.php b/plugins/02-PicoExcerpt.php
@@ -15,7 +15,7 @@
  *
  * @author  Daniel Rudolf
  * @link    http://picocms.org
- * @license http://opensource.org/licenses/MIT
+ * @license http://opensource.org/licenses/MIT The MIT License
  * @version 1.0
  */
 class PicoExcerpt extends AbstractPicoPlugin

diff --git a/plugins/DummyPlugin.php b/plugins/DummyPlugin.php
@@ -8,7 +8,7 @@
  *
  * @author  Daniel Rudolf
  * @link    http://picocms.org
- * @license http://opensource.org/licenses/MIT
+ * @license http://opensource.org/licenses/MIT The MIT License
  * @version 1.0
  */
 final class DummyPlugin extends AbstractPicoPlugin