Add Phpdoc to Crc32

beberlei · Mar 1, 2024 · f0e19f4 · f0e19f4
1 parent 04033f5
commit f0e19f4
Showing 1 changed file with 7 additions and 1 deletion.
diff --git a/src/Query/Mysql/Crc32.php b/src/Query/Mysql/Crc32.php
@@ -3,17 +3,23 @@
 namespace DoctrineExtensions\Query\Mysql;
 
 use Doctrine\ORM\Query\AST\Functions\FunctionNode;
+use Doctrine\ORM\Query\AST\Node;
 use Doctrine\ORM\Query\Parser;
 use Doctrine\ORM\Query\SqlWalker;
 use Doctrine\ORM\Query\TokenType;
 
 /**
- * "CRC32" "(" StringPrimary ")"
+ * Crc32Function ::= "CRC32" "(" StringPrimary ")"
+ *
+ * @link https://dev.mysql.com/doc/refman/en/mathematical-functions.html#function_crc32
  *
  * @author Igor Timoshenko <igor.timoshenko@i.ua>
+ * @example SELECT CRC32(foo.bar) FROM entity
+ * @example SELECT CRC32("string")
  */
 class Crc32 extends FunctionNode
 {
+    /** @var Node */
     public $stringPrimary;
 
     public function getSql(SqlWalker $sqlWalker): string