Improved documentation.

udan11 · udan11 · commit 0bff48ae488e · 2015-07-08T01:57:40.000+03:00
diff --git a/src/Fragments/AlterFragment.php b/src/Fragments/AlterFragment.php
@@ -108,7 +108,7 @@ public static function parse(Parser $parser, TokensList $list, array $options =
 
         /**
          * Counts brackets.
-         * @var int
+         * @var int $brackets
          */
         $brackets = 0;
 
@@ -130,7 +130,7 @@ public static function parse(Parser $parser, TokensList $list, array $options =
         for (; $list->idx < $list->count; ++$list->idx) {
             /**
              * Token parsed at this moment.
-             * @var Token
+             * @var Token $token
              */
             $token = $list->tokens[$list->idx];
 
diff --git a/src/Fragments/ArrayFragment.php b/src/Fragments/ArrayFragment.php
@@ -81,7 +81,7 @@ public static function parse(Parser $parser, TokensList $list, array $options =
         for (; $list->idx < $list->count; ++$list->idx) {
             /**
              * Token parsed at this moment.
-             * @var Token
+             * @var Token $token
              */
             $token = $list->tokens[$list->idx];
 
diff --git a/src/Fragments/CallKeyword.php b/src/Fragments/CallKeyword.php
@@ -82,7 +82,7 @@ public static function parse(Parser $parser, TokensList $list, array $options =
         for (; $list->idx < $list->count; ++$list->idx) {
             /**
              * Token parsed at this moment.
-             * @var Token
+             * @var Token $token
              */
             $token = $list->tokens[$list->idx];
 
diff --git a/src/Fragments/DataTypeFragment.php b/src/Fragments/DataTypeFragment.php
@@ -110,7 +110,7 @@ public static function parse(Parser $parser, TokensList $list, array $options =
         for (; $list->idx < $list->count; ++$list->idx) {
             /**
              * Token parsed at this moment.
-             * @var Token
+             * @var Token $token
              */
             $token = $list->tokens[$list->idx];
 
diff --git a/src/Fragments/FieldDefFragment.php b/src/Fragments/FieldDefFragment.php
@@ -154,7 +154,7 @@ public static function parse(Parser $parser, TokensList $list, array $options =
         for (; $list->idx < $list->count; ++$list->idx) {
             /**
              * Token parsed at this moment.
-             * @var Token
+             * @var Token $token
              */
             $token = $list->tokens[$list->idx];
 
diff --git a/src/Fragments/FieldFragment.php b/src/Fragments/FieldFragment.php
@@ -120,25 +120,25 @@ public static function parse(Parser $parser, TokensList $list, array $options =
 
         /**
          * Whether current tokens make an expression or a table reference.
-         * @var bool
+         * @var bool $isExpr
          */
         $isExpr = false;
 
         /**
          * Whether a period was previously found.
-         * @var bool
+         * @var bool $period
          */
         $period = false;
 
         /**
          * Whether an alias is expected. Is 2 if `AS` keyword was found.
-         * @var int
+         * @var int $alias
          */
         $alias = 0;
 
         /**
          * Counts brackets.
-         * @var int
+         * @var int $brackets
          */
         $brackets = 0;
 
@@ -148,14 +148,14 @@ public static function parse(Parser $parser, TokensList $list, array $options =
          *     string, if function was previously found;
          *     true, if open bracket was previously found;
          *     null, in any other case.
-         * @var string|bool
+         * @var string|bool $prev
          */
         $prev = null;
 
         for (; $list->idx < $list->count; ++$list->idx) {
             /**
              * Token parsed at this moment.
-             * @var Token
+             * @var Token $token
              */
             $token = $list->tokens[$list->idx];
 
diff --git a/src/Fragments/FieldListFragment.php b/src/Fragments/FieldListFragment.php
@@ -41,7 +41,7 @@ public static function parse(Parser $parser, TokensList $list, array $options =
         for (; $list->idx < $list->count; ++$list->idx) {
             /**
              * Token parsed at this moment.
-             * @var Token
+             * @var Token $token
              */
             $token = $list->tokens[$list->idx];
 
diff --git a/src/Fragments/IntoKeyword.php b/src/Fragments/IntoKeyword.php
@@ -76,7 +76,7 @@ public static function parse(Parser $parser, TokensList $list, array $options =
         for (; $list->idx < $list->count; ++$list->idx) {
             /**
              * Token parsed at this moment.
-             * @var Token
+             * @var Token $token
              */
             $token = $list->tokens[$list->idx];
 
diff --git a/src/Fragments/JoinKeyword.php b/src/Fragments/JoinKeyword.php
@@ -68,7 +68,7 @@ public static function parse(Parser $parser, TokensList $list, array $options =
         for (; $list->idx < $list->count; ++$list->idx) {
             /**
              * Token parsed at this moment.
-             * @var Token
+             * @var Token $token
              */
             $token = $list->tokens[$list->idx];
 
diff --git a/src/Fragments/KeyFragment.php b/src/Fragments/KeyFragment.php
@@ -114,7 +114,7 @@ public static function parse(Parser $parser, TokensList $list, array $options =
         for (; $list->idx < $list->count; ++$list->idx) {
             /**
              * Token parsed at this moment.
-             * @var Token
+             * @var Token $token
              */
             $token = $list->tokens[$list->idx];
 
diff --git a/src/Fragments/LimitKeyword.php b/src/Fragments/LimitKeyword.php
@@ -67,7 +67,7 @@ public static function parse(Parser $parser, TokensList $list, array $options =
         for (; $list->idx < $list->count; ++$list->idx) {
             /**
              * Token parsed at this moment.
-             * @var Token
+             * @var Token $token
              */
             $token = $list->tokens[$list->idx];
 
diff --git a/src/Fragments/OptionsFragment.php b/src/Fragments/OptionsFragment.php
@@ -56,13 +56,13 @@ public static function parse(Parser $parser, TokensList $list, array $options =
 
          /**
           * The ID that will be assigned to duplicate options.
-          * @var int
+          * @var int $lastAssignedId
           */
         $lastAssignedId = count($options) + 1;
 
         /**
          * The option that was processed last time.
-         * @var array
+         * @var array $lastOption
          */
         $lastOption = null;
         $lastOptionId = 0;
@@ -72,7 +72,7 @@ public static function parse(Parser $parser, TokensList $list, array $options =
         for (; $list->idx < $list->count; ++$list->idx) {
             /**
              * Token parsed at this moment.
-             * @var Token
+             * @var Token $token
              */
             $token = $list->tokens[$list->idx];
 
diff --git a/src/Fragments/OrderKeyword.php b/src/Fragments/OrderKeyword.php
@@ -69,7 +69,7 @@ public static function parse(Parser $parser, TokensList $list, array $options =
         for (; $list->idx < $list->count; ++$list->idx) {
             /**
              * Token parsed at this moment.
-             * @var Token
+             * @var Token $token
              */
             $token = $list->tokens[$list->idx];
 
diff --git a/src/Fragments/ParamDefFragment.php b/src/Fragments/ParamDefFragment.php
@@ -82,7 +82,7 @@ public static function parse(Parser $parser, TokensList $list, array $options =
         for (; $list->idx < $list->count; ++$list->idx) {
             /**
              * Token parsed at this moment.
-             * @var Token
+             * @var Token $token
              */
             $token = $list->tokens[$list->idx];
 
diff --git a/src/Fragments/ReferencesKeyword.php b/src/Fragments/ReferencesKeyword.php
@@ -101,7 +101,7 @@ public static function parse(Parser $parser, TokensList $list, array $options =
         for (; $list->idx < $list->count; ++$list->idx) {
             /**
              * Token parsed at this moment.
-             * @var Token
+             * @var Token $token
              */
             $token = $list->tokens[$list->idx];
 
diff --git a/src/Fragments/RenameKeyword.php b/src/Fragments/RenameKeyword.php
@@ -73,7 +73,7 @@ public static function parse(Parser $parser, TokensList $list, array $options =
         for (; $list->idx < $list->count; ++$list->idx) {
             /**
              * Token parsed at this moment.
-             * @var Token
+             * @var Token $token
              */
             $token = $list->tokens[$list->idx];
 
diff --git a/src/Fragments/SetKeyword.php b/src/Fragments/SetKeyword.php
@@ -69,7 +69,7 @@ public static function parse(Parser $parser, TokensList $list, array $options =
         for (; $list->idx < $list->count; ++$list->idx) {
             /**
              * Token parsed at this moment.
-             * @var Token
+             * @var Token $token
              */
             $token = $list->tokens[$list->idx];
 
diff --git a/src/Fragments/ValuesKeyword.php b/src/Fragments/ValuesKeyword.php
@@ -67,7 +67,7 @@ public static function parse(Parser $parser, TokensList $list, array $options =
         for (; $list->idx < $list->count; ++$list->idx) {
             /**
              * Token parsed at this moment.
-             * @var Token
+             * @var Token $token
              */
             $token = $list->tokens[$list->idx];
 
diff --git a/src/Fragments/WhereKeyword.php b/src/Fragments/WhereKeyword.php
@@ -87,7 +87,7 @@ public static function parse(Parser $parser, TokensList $list, array $options =
 
         /**
          * Counts brackets.
-         * @var int
+         * @var int $brackets
          */
         $brackets = 0;
 
@@ -104,7 +104,7 @@ public static function parse(Parser $parser, TokensList $list, array $options =
 
             /**
              * Token parsed at this moment.
-             * @var Token
+             * @var Token $token
              */
             $token = $list->tokens[$list->idx];
 
diff --git a/src/Lexer.php b/src/Lexer.php
@@ -287,19 +287,19 @@ public function parseKeyword()
 
         /**
          * Value to be returned.
-         * @var Token
+         * @var Token $ret
          */
         $ret = null;
 
         /**
          * The value of `$this->last` where `$token` ends in `$this->str`.
-         * @var int
+         * @var int $iEnd
          */
         $iEnd = $this->last;
 
         /**
          * Whether last parsed character is a whitespace.
-         * @var bool
+         * @var bool $lastSpace
          */
         $lastSpace = false;
 
@@ -343,13 +343,13 @@ public function parseOperator()
 
         /**
          * Value to be returned.
-         * @var Token|bool
+         * @var Token $ret
          */
         $ret = null;
 
         /**
          * The value of `$this->last` where `$token` ends in `$this->str`.
-         * @var int
+         * @var int $iEnd
          */
         $iEnd = $this->last;
 
diff --git a/src/Parser.php b/src/Parser.php
@@ -278,33 +278,33 @@ public function parse()
 
         /**
          * Last parsed statement.
-         * @var Statement
+         * @var Statement $lastStatement
          */
         $lastStatement = null;
 
         /**
          * Whether a union is parsed or not.
-         * @var bool
+         * @var bool $inUnion
          */
         $inUnion = true;
 
         /**
          * The index of the last token from the last statement.
-         * @var int
+         * @var int $prevLastIdx
          */
         $prevLastIdx = -1;
 
         /**
          * The list of tokens.
-         * @var TokensList
+         * @var TokensList $list
          */
         $list = &$this->list;
 
         for (; $list->idx < $list->count; ++$list->idx) {
 
             /**
              * Token parsed at this moment.
-             * @var Token
+             * @var Token $token
              */
             $token = $list->tokens[$list->idx];
 
@@ -334,13 +334,13 @@ public function parse()
 
             /**
              * The name of the class that is used for parsing.
-             * @var string
+             * @var string $class
              */
             $class = static::$STATEMENT_PARSERS[$token->value];
 
             /**
              * Processed statement.
-             * @var Statement
+             * @var Statement $stmt
              */
             $stmt = new $class($this, $this->list);
 
diff --git a/src/Statement.php b/src/Statement.php
diff --git a/src/Statements/AlterStatement.php b/src/Statements/AlterStatement.php
diff --git a/src/Statements/NotImplementedStatement.php b/src/Statements/NotImplementedStatement.php
diff --git a/src/Utils/Query.php b/src/Utils/Query.php
