Add configuration option to disable logging for a specific error message per directory #40

Closed
mvriel opened this Issue Apr 10, 2011 · 1 comment

Comments

Projects
None yet
1 participant
@mvriel
Member

mvriel commented Apr 10, 2011

Some projects do not use File level DocBlocks; we would want to disable the error that a parsing error has occurred in this situation. Sometimes a vendor library is included in the documentation generation but should all errors related to invalid DocBlock be ignored because the developer does not want to maintain this library himself and the error pollute his own working stack.

Note: there is currently no 'centralized' system to track these kind of errors; they are now thrown by logging a WARN, ERR or CRIT. A more intelligent analysis result handling system should be added which is finetunable.


During research we have come to the conclusion to use the same configuration format as is used by PHP_CodeSniffer and be able to (re)define entire rulesets. The following tasks need to be completed

  • Write technical specification for this feature
  • Create Ruleset and Rule objects
  • Create a pre-defined 'Default' Ruleset
  • Create a pre-defined Ruleset without File DocBlock validation (often requested feature)
  • Load a Ruleset from the Configuration file
  • Load a Ruleset directly from a 'ruleset.xml' file
  • A Ruleset may refer/include another ruleset
  • When including another ruleset specific Rules may be excluded from being enabled
  • Only load/enable validators that have a violation that matches one of the Rules in a Ruleset
  • When executing validators, only register violations that matches one of the Rules in a Ruleset
  • When executing validators, override loglevel with severity in rule
  • Add support for silencing validators for specific folders
  • Re-enable support for the Deprecated and Required validator
  • Add support for validating only specific folders
  • Allow 'properties' to be passed to validators to change their behavior

This story is also a prerequisite for #1421

@ghost ghost assigned mvriel Apr 10, 2011

mvriel added a commit to mvriel/phpDocumentor2 that referenced this issue Dec 29, 2011

mvriel added a commit to mvriel/phpDocumentor2 that referenced this issue Dec 29, 2011

mvriel added a commit to mvriel/phpDocumentor2 that referenced this issue Dec 29, 2011

mvriel added a commit that referenced this issue Jan 9, 2012

@mvriel mvriel added this to the 2.4 milestone Feb 27, 2014

@mvriel mvriel modified the milestones: 2.5, 2.4 Mar 30, 2014

@mvriel mvriel modified the milestones: 2.6, 2.5, 2.7 May 17, 2014

@mvriel mvriel modified the milestones: 2.7, 2.8 Aug 30, 2014

@mvriel mvriel self-assigned this Sep 2, 2014

@mvriel mvriel added the in progress label Sep 2, 2014

@mvriel mvriel referenced this issue Sep 3, 2014

Open

Consider adding a sniff command #1421

0 of 5 tasks complete

mvriel added a commit to mvriel/phpDocumentor2 that referenced this issue Sep 19, 2014

mvriel added a commit to mvriel/phpDocumentor2 that referenced this issue Sep 25, 2014

#40: Basic Implementation for Documentation Standards
In this commit I have added on the previous commit to create a
baseline way of dealign with Documentation Standard. phpDocumentor
now supports rulesets in the same way as PHP_CodeSniffer and as
such allows the custom creation of standards.

With this feature it will be possible to finetune and tweak how
your documentation is validated.

@mvriel mvriel modified the milestones: Blue Lightning, 2.8 Oct 23, 2014

@mvriel mvriel added the Roadmap label Oct 23, 2014

@mvriel mvriel modified the milestones: Blue Lightning, 3.0 Feb 18, 2015

@mvriel mvriel removed the Improvement label Aug 22, 2015

@mvriel mvriel removed the Roadmap label Aug 22, 2015

@mvriel

This comment has been minimized.

Show comment
Hide comment
@mvriel

mvriel Aug 22, 2015

Member

This issue is superseded by #1599

Member

mvriel commented Aug 22, 2015

This issue is superseded by #1599

@mvriel mvriel closed this Aug 22, 2015

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment