lechimp-p / dicto.php

src/Rules/ContainText.php

Unused Use Statements -1 removed lines

@@ -12,7 +12,6 @@
 
 use Lechimp\Dicto\Regexp;
 use Lechimp\Dicto\Analysis\Index;
-use Lechimp\Dicto\Analysis\Violation;
 use Lechimp\Dicto\Definition\ArgumentParser;
 use Lechimp\Dicto\Graph\Node;
 use Lechimp\Dicto\Graph\PredicateFactory;

Doc Comments +3 added lines

@@ -160,6 +160,9 @@
             );
     }
 
+    /**
+     * @param boolean $negate
+     */
     protected function regexp_source_filter(PredicateFactory $f, Regexp $regexp, $negate)
     {
         assert('is_bool($negate)');

src/App/App.php

Doc Comments +1 added lines, -1 removed lines

@@ -79,7 +79,7 @@
      * Load extra configs from yaml files.
      *
      * @param   array   $config_file_paths
-     * @return  array
+     * @return  Config
      */
     protected function load_config(array $config_file_paths)
     {

src/Definition/AST/Factory.php

Doc Comments +2 added lines, -5 removed lines

@@ -44,7 +44,7 @@ 
 
     /**
      * @param   string  $atom
-     * @return  Name
+     * @return  Atom
      */
     public function atom($atom)
     {
@@ -126,11 +126,8 @@ 
     }
 
     /**
-     * @param   Definition  $left
      * @param   Qualifier   $qualifier
-     * @param   Atom        $id
-     * @param   Parameter[] $parameters
-     * @return  Property
+     * @return  Rule
      */
     public function rule(Qualifier $qualifier, Definition $definition)
     {

src/Definition/ASTParser.php

Doc Comments +8 added lines, -7 removed lines

@@ -163,7 +163,7 @@ 
     // IMPLEMENTATION OF Parser
 
     /**
-     * @return  Ruleset
+     * @return  AST\Root
      */
     public function parse($source)
     {
@@ -176,7 +176,7 @@ 
      * Root expression for the parser is some whitespace or comment where a
      * top level statement is in the middle.
      *
-     * @return  Ruleset
+     * @return  AST\Root
      */
     protected function root()
     {
@@ -240,6 +240,7 @@ 
 
     /**
      * @param   string
+     * @param string $content
      * @return  string
      */
     protected function trim_explanation($content)
@@ -267,7 +268,7 @@ 
     /**
      * Fetch a string from the stream.
      *
-     * @return  string
+     * @return  AST\StringValue
      */
     protected function string()
     {
@@ -287,7 +288,7 @@ 
     /**
      * Fetch a variable from the stream.
      *
-     * @return  V\Variable
+     * @return  AST\Definition
      */
     protected function variable($right_binding_power = 0)
     {
@@ -348,7 +349,7 @@ 
     /**
      * Fetch a rule schema and its arguments from the stream.
      *
-     * @return  array   (R\Schema, array)
+     * @return  AST\Atom   (R\Schema, array)
      */
     protected function schema()
     {
@@ -367,7 +368,7 @@ 
     /**
      * Process a variable assignment.
      *
-     * @return  null
+     * @return  AST\Assignment
      */
     protected function variable_assignment()
     {
@@ -381,7 +382,7 @@ 
     /**
      * Process a rule declaration.
      *
-     * @return  null
+     * @return  AST\Rule
      */
     protected function rule_declaration()
     {

src/Definition/Compiler.php

Doc Comments +7 added lines, -4 removed lines

@@ -86,7 +86,7 @@ 
      * Compile an AST to an according entity.
      *
      * @param   AST\Node    $node
-     * @return  mixed
+     * @return  Ruleset
      */
     public function compile(AST\Root $node)
     {
@@ -215,6 +215,9 @@ 
         return $parameters;
     }
 
+    /**
+     * @return string
+     */
     protected function compile_qualifier(AST\Qualifier $node)
     {
         $which = $node->which();
@@ -251,7 +254,7 @@ 
      * Get a predefined variable.
      *
      * @param   string  $name
-     * @return  V\Variable
+     * @return  V\Variable[]
      */
     protected function get_variable($name)
     {
@@ -265,7 +268,7 @@ 
      * Get a property. Yes. Really.
      *
      * @param   string  $name
-     * @return  V\Property
+     * @return  R\Property[]
      */
     protected function get_property($name)
     {
@@ -279,7 +282,7 @@ 
      * Get a schema. By name.
      *
      * @param   string  $name
-     * @return  V\Schema
+     * @return  R\Schema
      */
     protected function get_schema($name)
     {

src/Graph/QueryImpl.php

Doc Comments +5 added lines, -5 removed lines

@@ -111,7 +111,7 @@ 
     }
 
     /**
-     * @return  Iterator <[Node,mixed]>
+     * @return  \Generator <[Node,mixed]>
      */
     protected function switch_run_command(\Iterator $nodes, $step)
     {
@@ -128,7 +128,7 @@ 
     }
 
     /**
-     * @return  Iterator <[Node,mixed]>
+     * @return  \Generator <[Node,mixed]>
      */
     protected function run_expand(\Iterator $nodes, \Closure $clsr)
     {
@@ -143,7 +143,7 @@ 
     }
 
     /**
-     * @return  Iterator <[Node,mixed]>
+     * @return  \Generator <[Node,mixed]>
      */
     protected function run_extract(\Iterator $nodes, \Closure $clsr)
     {
@@ -159,7 +159,7 @@ 
     }
 
     /**
-     * @return  Iterator <[Node,mixed]>
+     * @return  \Generator <[Node,mixed]>
      */
     protected function run_filter(\Iterator $nodes, \Closure $predicate)
     {
@@ -174,7 +174,7 @@ 
     }
 
     /**
-     * @return  Iterator <[Node,mixed]>
+     * @return  \Generator <[Node,mixed]>
      */
     protected function add_result(\Iterator $nodes, &$result)
     {

src/Indexer/Indexer.php

Doc Comments +1 added lines

@@ -88,6 +88,7 @@
     /**
      * Initialize the filesystem abstraction.
      *
+     * @param string $path
      * @return  Flightcontrol
      */
     public function init_flightcontrol($path)

src/Report/Generator.php

Doc Comments +1 added lines

@@ -96,6 +96,7 @@
      * If that is also not the case, we assume the class is in the global
      * namespace.
      *
+     * @param string $name
      * @return  string
      */
     protected function fully_qualified_class_name($name)

src/Report/Queries.php

Doc Comments +1 added lines, -1 removed lines

@@ -117,7 +117,7 @@
      * Get information about a run.
      *
      * @param   int $run
-     * @return  array<string,string>     with keys 'commit_hash'
+     * @return  integer     with keys 'commit_hash'
      */
     public function run_info($run)
     {