Unify doc comment styles

[ci skip] still no PSR tests :/

src/Luminous.php

@@ -9,7 +9,7 @@
  * the abstract class methods.
  */
 
-/// @cond USER
+/** @cond USER */
 
 // here's our 'real' UI class, which uses the above singleton. This is all
 // static because these are actually procudural functions, we're using the
@@ -318,11 +318,11 @@ public static function guessLanguage($src, $confidence = 0.05, $default = 'plain
      *    probable language coming first in the array.
      *    Each array element is an array which represents a language (scanner),
      *    and has the keys:
-     *    \li \c 'language' => Human-readable language description,
-     *    \li \c 'codes' => valid codes for the language (array),
-     *    \li \c 'p' => the probability (between 0.0 and 1.0 inclusive),
+     *    @li @c 'language' => Human-readable language description,
+     *    @li @c 'codes' => valid codes for the language (array),
+     *    @li @c 'p' => the probability (between 0.0 and 1.0 inclusive),
      *
-     * note that \c 'language' and \c 'codes' are the key => value pair from
+     * note that @c 'language' and @c 'codes' are the key => value pair from
      * luminous::scanners()
      *
      * @warning Language guessing is inherently unreliable but should be right
@@ -435,5 +435,4 @@ public static function headHtml()
     }
 }
 
-/// @endcond
-// ends user
+/** @endcond */

src/Luminous/Caches/Cache.php

@@ -1,5 +1,5 @@
 <?php
-/// @cond ALL
+/** @cond ALL */
 
 namespace Luminous\Caches;
 
@@ -116,4 +116,4 @@ public function write($data)
     }
 }
 
-/// @endcond
+/** @endcond */

src/Luminous/Caches/FileSystemCache.php

@@ -1,5 +1,5 @@
 <?php
-/// @cond ALL
+/** @cond ALL */
 
 namespace Luminous\Caches;
 
@@ -22,22 +22,29 @@
  *
  * This driver implements necessary functions for reading/writing the cache
  * and performing maintenance.
- *
  */
 class FileSystemCache extends Cache
 {
-    /// root cache directory
+    /**
+     * root cache directory
+     */
     private $dir = null;
 
-    /// full path to the cached file (for convenience)
+    /**
+     * full path to the cached file (for convenience)
+     */
     private $path = null;
 
-    /// subdir within the cache - we factor out the first two
-    /// characters of the filename, this reduces the number of files in
-    /// any one folder.
+    /**
+     * subdir within the cache - we factor out the first two
+     * characters of the filename, this reduces the number of files in
+     * any one folder.
+     */
     private $subdir = null;
 
-    /// the base filename of the cached file
+    /**
+     * the base filename of the cached file
+     */
     private $filename = null;
 
     public function __construct($id)
@@ -171,4 +178,4 @@ protected function purgeInternal()
     }
 }
 
-/// @endcond
+/** @endcond */

src/Luminous/Caches/SqlCache.php

@@ -1,5 +1,5 @@
 <?php
-/// @cond ALL
+/** @cond ALL */
 
 namespace Luminous\Caches;
 
@@ -155,4 +155,4 @@ protected function purgeInternal()
     }
 }
 
-/// @endcond
+/** @endcond */

src/Luminous/Cli.php

@@ -1,5 +1,5 @@
 <?php
-///@cond ALL
+/** @cond ALL */
 
 namespace Luminous;
 
@@ -127,7 +127,6 @@ public function parseArgs()
         }
     }
 
-
     public function highlight()
     {
         $this->parseArgs();
@@ -218,4 +217,4 @@ public function highlight()
     }
 }
 
-///@endcond
+/** @endcond */

src/Luminous/Core/Filters.php

@@ -1,20 +1,17 @@
 <?php
 
-/**
- * @cond CORE
- */
+/** @cond CORE */
 
 namespace Luminous\Core;
 
-/*
+/**
  * @brief A collection of useful common filters.
  *
  * Filters are either stream filters or individual filters.
  * Stream filters operate on the entire token stream, and return the new
  * token stream. Individual filters operate on individual tokens (bound by type),
  * and return the new token. Any publicly available member here is one of those,
  * therefore the return and param documents are omitted.
- *
  */
 class Filters
 {
@@ -338,5 +335,4 @@ public static function ooStreamFilter($tokens)
     }
 }
 
-/// @endcond
-// end CORE
+/** @endcond */

src/Luminous/Core/Scanners/EmbeddedWebScriptScanner.php

@@ -1,6 +1,6 @@
 <?php
 
-/// @cond CORE
+/** @cond CORE */
 
 namespace Luminous\Core\Scanners;
 
@@ -21,9 +21,9 @@
  * state, which might be necessary if they are interrupted by server-side tags.
  * For this reason, the main() method might be called multiple times, therefore
  * each web sub-scanner should
- *     \li Not rely on keeping state related data in main()'s function scope,
+ *     @li Not rely on keeping state related data in main()'s function scope,
  *              make it a class variable
- *      \li flush its token stream every time main() is called
+ *      @li flush its token stream every time main() is called
  *
  * The init method of the class should be used to set relevant rules based
  * on whether or not the embedded flags are set; and therefore the embedded
@@ -51,10 +51,14 @@ abstract class EmbeddedWebScriptScanner extends Scanner
      */
     public $serverTags = '/<\?/';
 
-    /// @brief closing HTML tag for our code, e.g \</script\>
+    /**
+     * @brief closing HTML tag for our code, e.g \</script\>
+     */
     public $scriptTags;
 
-    /** @brief I think this is ignored and obsolete */
+    /**
+     * @brief I think this is ignored and obsolete
+     */
     public $interrupt = false;
 
     /**
@@ -105,7 +109,9 @@ public function addChildScanner($name, $scanner)
         $this->childScanners[$name] = $scanner;
     }
 
-    // override string to hit the child scanners as well
+    /**
+     * override string to hit the child scanners as well
+     */
     public function string($str = null)
     {
         if ($str !== null) {
@@ -265,4 +271,4 @@ public function scriptBreak($tokenName, $match = null, $pos = null)
     }
 }
 
-/// @endcond
+/** @endcond */

src/Luminous/Core/Scanners/Scanner.php

@@ -1,6 +1,6 @@
 <?php
 
-/// @cond CORE
+/** @cond CORE */
 
 /**
  * @file
@@ -50,10 +50,11 @@
  *              index stores whether or nto it has been escaped.
  *
  */
-
 class Scanner extends StringScanner
 {
-    /// scanner version.
+    /**
+     * scanner version.
+     */
     public $version = 'master';
 
     /**
@@ -131,7 +132,9 @@ class Scanner extends StringScanner
      */
     protected $caseSensitive = true;
 
-    /// constructor
+    /**
+     * constructor
+     */
     public function __construct($src = null)
     {
         parent::__construct($src);
@@ -241,7 +244,6 @@ public function init()
      * The main method is fully responsible for tokenizing the string stored
      * in string() at the time of its call. By the time main returns, it should
      * have consumed the whole of the string and populated the token array.
-     *
      */
     public function main()
     {
@@ -309,7 +311,6 @@ public function removeStreamFilter($name)
      * A stream filter receives the entire token stream and should return it.
      *
      * The parameters are: ([name], filter). Name is an optional argument.
-     *
      */
     public function addStreamFilter($arg1, $arg2 = null)
     {
@@ -357,7 +358,7 @@ public function pop()
 
     /**
      * @brief Flushes the token stream
-    */
+     */
     public function start()
     {
         $this->tokens = array();
@@ -533,7 +534,6 @@ public function skipWhitespace()
      *
      * @throws Exception if called at a non-matching point (i.e.
      * <code>$this->scan($open)</code> does not match)
-     *
      */
     public function nestableToken($tokenName, $open, $close)
     {
@@ -562,4 +562,4 @@ public function nestableToken($tokenName, $open, $close)
     }
 }
 
-/// @endcond
+/** @endcond */

src/Luminous/Core/Scanners/SimpleScanner.php

@@ -1,6 +1,6 @@
 <?php
 
-/// @cond CORE
+/** @cond CORE */
 
 namespace Luminous\Core\Scanners;
 
@@ -63,4 +63,4 @@ public function main()
     }
 }
 
-/// @endcond CORE
+/** @endcond CORE */

src/Luminous/Core/Scanners/StatefulScanner.php

@@ -1,6 +1,6 @@
 <?php
 
-/// @cond CORE
+/** @cond CORE */
 
 namespace Luminous\Core\Scanners;
 
@@ -34,15 +34,15 @@
  * stores the current state data. State data is currently a pattern, as the
  * above tuple.
  *
- *
  * @warning Currently 'stream filters' are not applied, because we at no point
  * end up with a flat stream of tokens. Although the rule name remapper is
  * applied.
- *
  */
 class StatefulScanner extends SimpleScanner
 {
-    /// @brief Transition table
+    /**
+     * @brief Transition table
+     */
     protected $transitions = array();
 
     /**
@@ -73,15 +73,21 @@ class StatefulScanner extends SimpleScanner
      */
     protected $tokenTreeStack = array();
 
-    /// Records whether or not the FSM has been set up for the first time.
-    /// @see setup()
+    /**
+     * Records whether or not the FSM has been set up for the first time.
+     * @see setup()
+     */
     private $setup = false;
-    /// remembers the state on the last iteration so we know whether or not
-    /// to load in a new transition-set
+    /**
+     * remembers the state on the last iteration so we know whether or not
+     * to load in a new transition-set
+     */
     private $lastState = null;
 
-    /// Cache of transition rules
-    /// @see next_start_data()
+    /**
+     * Cache of transition rules
+     * @see next_start_data()
+     */
     private $transitionRuleCache = array();
 
     /**
@@ -288,7 +294,6 @@ protected function setup()
      * @warning the second and third parameters are not applicable to this
      * method, they are only present to suppress PHP warnings. If you set them,
      * an exception is thrown.
-     *
      */
     public function record($str, $dummy1 = null, $dummy2 = null)
     {
@@ -453,4 +458,4 @@ public function tagged()
     }
 }
 
-/// @endcond CORE
+/** @endcond CORE */