lechimp-p / dicto.php

src/Report/Generator.php

Doc Comments +1 added lines

@@ -90,6 +90,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/App/Config.php

Doc Comments +15 added lines

@@ -68,6 +68,9 @@ 
         return $tree_builder;
     }
 
+    /**
+     * @param \Symfony\Component\Config\Definition\Builder\NodeBuilder $c
+     */
     protected function add_project_node($c) {
         $c->arrayNode("project")
             ->children()
@@ -84,6 +87,9 @@ 
         ->end();
     }
 
+    /**
+     * @param \Symfony\Component\Config\Definition\Builder\NodeBuilder $c
+     */
     protected function add_analysis_node($c) {
         $c->arrayNode("analysis")
             ->children()
@@ -103,6 +109,9 @@ 
         ->end();
     }
 
+    /**
+     * @param \Symfony\Component\Config\Definition\Builder\NodeBuilder $c
+     */
     protected function add_rules_node($c) {
         $c->arrayNode("rules")
             ->children()
@@ -146,6 +155,9 @@ 
         ->end();
     }
 
+    /**
+     * @param \Symfony\Component\Config\Definition\Builder\NodeBuilder $c
+     */
     protected function add_runtime_node($c) {
         $c->arrayNode("runtime")
             ->children()
@@ -157,6 +169,9 @@ 
         ->end();
     }
 
+    /**
+     * @param \Symfony\Component\Config\Definition\Builder\NodeBuilder $c
+     */
     protected function add_reports_node($c) {
         $c->arrayNode("reports")
             ->prototype("array")

Unused Use Statements -1 removed lines

@@ -11,7 +11,6 @@
 namespace Lechimp\Dicto\App;
 
 use Lechimp\Dicto\Report;
-
 use Symfony\Component\Config\Definition\Processor;
 use Symfony\Component\Config\Definition\ConfigurationInterface;
 use Symfony\Component\Config\Definition\Builder\TreeBuilder;

src/Graph/QueryImpl.php

Doc Comments +5 added lines, -5 removed lines

@@ -106,7 +106,7 @@ 
     }
 
     /**
-     * @return  Iterator <[Node,mixed]>
+     * @return  \Generator <[Node,mixed]>
      */
     protected function switch_run_command(\Iterator $nodes, $step) {
         list($cmd,$par) = $step;
@@ -125,7 +125,7 @@ 
     }
 
     /**
-     * @return  Iterator <[Node,mixed]>
+     * @return  \Generator <[Node,mixed]>
      */
     protected function run_expand(\Iterator $nodes, \Closure $clsr) {
         while ($nodes->valid()) {
@@ -139,7 +139,7 @@ 
     }
 
     /**
-     * @return  Iterator <[Node,mixed]>
+     * @return  \Generator <[Node,mixed]>
      */
     protected function run_extract(\Iterator $nodes, \Closure $clsr) {
         while ($nodes->valid()) {
@@ -154,7 +154,7 @@ 
     }
 
     /**
-     * @return  Iterator <[Node,mixed]>
+     * @return  \Generator <[Node,mixed]>
      */
     protected function run_filter(\Iterator $nodes, \Closure $predicate) {
         while ($nodes->valid()) {
@@ -168,7 +168,7 @@ 
     }
 
     /**
-     * @return  Iterator <[Node,mixed]>
+     * @return  \Generator <[Node,mixed]>
      */
     protected function add_result(\Iterator $nodes, &$result) {
         while ($nodes->valid()) {

src/Rules/ContainText.php

Doc Comments +3 added lines

@@ -153,6 +153,9 @@
             );
     }
 
+    /**
+     * @param boolean $negate
+     */
     protected function regexp_source_filter(PredicateFactory $f, Regexp $regexp, $negate) {
         assert('is_bool($negate)');
         return $f->_custom(function(Graph\Entity $e) use ($regexp, $negate) {

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;

src/Definition/AST/Factory.php

Doc Comments +2 added lines, -5 removed lines

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

src/Definition/ASTParser.php

Doc Comments +8 added lines, -7 removed lines

@@ -159,7 +159,7 @@ 
     // IMPLEMENTATION OF Parser
 
     /**
-     * @return  Ruleset
+     * @return  AST\Root
      */
     public function parse($source) {
         $this->variables = array();
@@ -171,7 +171,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() {
         $lines = [];
@@ -232,6 +232,7 @@ 
 
     /**
      * @param   string
+     * @param string $content
      * @return  string
      */
     protected function trim_explanation($content) {
@@ -257,7 +258,7 @@ 
     /**
      * Fetch a string from the stream.
      *
-     * @return  string
+     * @return  AST\StringValue
      */
     protected function string() {
         $m = $this->current_match();
@@ -271,7 +272,7 @@ 
     /**
      * Fetch a variable from the stream.
      *
-     * @return  V\Variable
+     * @return  AST\Definition
      */
     protected function variable($right_binding_power = 0) {
         $t = $this->current_symbol();
@@ -326,7 +327,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() {
         $t = $this->current_symbol();
@@ -344,7 +345,7 @@ 
     /**
      * Process a variable assignment.
      *
-     * @return  null
+     * @return  AST\Assignment
      */
     protected function variable_assignment() {
         $m = $this->current_match(); 
@@ -357,7 +358,7 @@ 
     /**
      * Process a rule declaration.
      *
-     * @return  null
+     * @return  AST\Rule
      */
     protected function rule_declaration() {
         if ($this->is_current_token_matched_by("only")) {

src/Definition/Compiler.php

Doc Comments +7 added lines, -4 removed lines

@@ -80,7 +80,7 @@ 
      * Compile an AST to an according entity.
      *
      * @param   AST\Node    $node
-     * @return  mixed
+     * @return  Ruleset
      */
     public function compile(AST\Root $node) {
         $this->variables = array();
@@ -203,6 +203,9 @@ 
         return $parameters;
     }
 
+    /**
+     * @return string
+     */
     protected function compile_qualifier(AST\Qualifier $node) {
         $which = $node->which();
         if ($which === AST\Qualifier::MUST) {
@@ -237,7 +240,7 @@ 
      * Get a predefined variable.
      *
      * @param   string  $name
-     * @return  V\Variable
+     * @return  V\Variable[]
      */
     protected function get_variable($name) {
         if (!array_key_exists($name, $this->variables)) {
@@ -250,7 +253,7 @@ 
      * Get a property. Yes. Really.
      *
      * @param   string  $name
-     * @return  V\Property
+     * @return  R\Property[]
      */
     protected function get_property($name) {
         if (!array_key_exists($name, $this->properties)) {
@@ -263,7 +266,7 @@ 
      * Get a schema. By name.
      *
      * @param   string  $name
-     * @return  V\Schema
+     * @return  R\Schema
      */
     protected function get_schema($name) {
         if (!array_key_exists($name, $this->schemas)) {

src/Report/Queries.php

Doc Comments +1 added lines, -1 removed lines

@@ -111,7 +111,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) {
         $b = $this->result_db->builder();

src/Rules/Rule.php

Doc Comments +2 added lines, -2 removed lines

@@ -97,7 +97,7 @@ 
     /**
      * Get all variables referenced by the rule.
      *
-     * @return  Vars\Variable[]
+     * @return  Variable[]
      */
     public function variables() {
         $vars = array($this->subject());
@@ -141,7 +141,7 @@ 
      * Compile the rule to SQL.
      *
      * @param   Index   $index
-     * @return  Query[]
+     * @return  \Lechimp\Dicto\Graph\Query[]
      */
     public function compile(Index $index) {
         return $this->schema->compile($index, $this);