Improve phpDocs class docs

This commit is contained in:
Daniel Rudolf 2016-05-23 15:13:56 +02:00
parent 79bb543c46
commit 94279c57f8
No known key found for this signature in database
GPG key ID: A061F02CD8DE4538
9 changed files with 13 additions and 11 deletions

View file

@ -12,7 +12,7 @@
* *
* @author Gilbert Pellegrom * @author Gilbert Pellegrom
* @link http://picocms.org * @link http://picocms.org
* @license http://opensource.org/licenses/MIT * @license http://opensource.org/licenses/MIT The MIT License
* @version 1.0 * @version 1.0
*/ */

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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