Menu

#59 Enhancement: Add allowed exceptions to docBlocks section of configuration

Fixed
nobody
None
Medium
Defect
2013-12-02
2013-11-08
Anonymous
No

Originally created by: kbcm...@gmail.com

The sample configuration shows this:

    <!-- Tests that every function and class is immediately preceded by a docblock. A property "excludePrivateMembers" can be set if you want to disable docblocks for private member functions. -->
    <test name="docBlocks">
        <property name="excludePrivateMembers" value="true"/>
        <property name="testReturn" value="true"/>
        <property name="testParam" value="true"/>
        <property name="testThrow" value="true"/>
    </test>

I was expecting to be able to add <exception name="__toString"> to tell it that a docBlock is not required for functions with this name (since it's already pretty self-evident). If it's really that self-evident, maybe a docBlock shouldn't be required.

Related

Wiki: History

Discussion

  • Anonymous

    Anonymous - 2013-11-11

    Originally posted by: tch...@hotmail.com

    (No comment was entered for this change.)

    Status: Accepted

     
  • Anonymous

    Anonymous - 2013-12-02

    Originally posted by: tch...@hotmail.com

    OK, added a test for exception.

    Just, the config should be something like ("name" would have been easier to read but "value" is already used somewhere else) :
    <exception value="__toString">

    Status: Fixed

     

Log in to post a comment.

Want the latest updates on software, tech news, and AI?
Get latest updates about software, tech news, and AI from SourceForge directly in your inbox once a month.