Ver código fonte

Class docs: Use default markdown table format

Daniel Rudolf 9 anos atrás
pai
commit
93f7aaad8b
3 arquivos alterados com 6 adições e 15 exclusões
  1. 2 5
      lib/Pico.php
  2. 2 5
      plugins/00-PicoDeprecated.php
  3. 2 5
      plugins/DummyPlugin.php

+ 2 - 5
lib/Pico.php

@@ -909,10 +909,9 @@ class Pico
      * Reads the data of all pages known to Pico
      *
      * The page data will be an array containing the following values:
-     * <pre>
-     * +----------------+--------+------------------------------------------+
+     *
      * | Array key      | Type   | Description                              |
-     * +----------------+--------+------------------------------------------+
+     * | -------------- | ------ | ---------------------------------------- |
      * | id             | string | relative path to the content file        |
      * | url            | string | URL to the page                          |
      * | title          | string | title of the page (YAML header)          |
@@ -923,8 +922,6 @@ class Pico
      * | date_formatted | string | formatted date of the page               |
      * | raw_content    | string | raw, not yet parsed contents of the page |
      * | meta           | string | parsed meta data of the page             |
-     * +----------------+--------+------------------------------------------+
-     * </pre>
      *
      * @see    Pico::sortPages()
      * @see    Pico::getPages()

+ 2 - 5
plugins/00-PicoDeprecated.php

@@ -11,10 +11,9 @@
  * can disable this plugin by calling {@link PicoDeprecated::setEnabled()}.
  *
  * The following deprecated events are triggered by this plugin:
- * <pre>
- * +---------------------+-----------------------------------------------------------+
+ *
  * | Event               | ... triggers the deprecated event                         |
- * +---------------------+-----------------------------------------------------------+
+ * | ------------------- | --------------------------------------------------------- |
  * | onPluginsLoaded     | plugins_loaded()                                          |
  * | onConfigLoaded      | config_loaded($config)                                    |
  * | onRequestUrl        | request_url($url)                                         |
@@ -32,8 +31,6 @@
  * | onTwigRegistration  | before_twig_register()                                    |
  * | onPageRendering     | before_render($twigVariables, $twig, $templateName)       |
  * | onPageRendered      | after_render($output)                                     |
- * +---------------------+-----------------------------------------------------------+
- * </pre>
  *
  * Since Pico 1.0 the config is stored in {@path "config/config.php"}. This
  * plugin tries to read {@path "config.php"} in Pico's root dir and overwrites

+ 2 - 5
plugins/DummyPlugin.php

@@ -228,10 +228,9 @@ final class DummyPlugin extends AbstractPicoPlugin
      * Triggered when Pico reads a single page from the list of all known pages
      *
      * The `$pageData` parameter consists of the following values:
-     * <pre>
-     * +----------------+--------+------------------------------------------+
+     *
      * | Array key      | Type   | Description                              |
-     * +----------------+--------+------------------------------------------+
+     * | -------------- | ------ | ---------------------------------------- |
      * | id             | string | relative path to the content file        |
      * | url            | string | URL to the page                          |
      * | title          | string | title of the page (YAML header)          |
@@ -242,8 +241,6 @@ final class DummyPlugin extends AbstractPicoPlugin
      * | date_formatted | string | formatted date of the page               |
      * | raw_content    | string | raw, not yet parsed contents of the page |
      * | meta           | string | parsed meta data of the page             |
-     * +----------------+--------+------------------------------------------+
-     * </pre>
      *
      * @see    DummyPlugin::onPagesLoaded()
      * @param  array &$pageData data of the loaded page