Make WordPress Core

Changeset 47122 for trunk/phpcs.xml.dist


Ignore:
Timestamp:
01/29/2020 12:43:23 AM (5 years ago)
Author:
SergeyBiryukov
Message:

Docs: Improve inline comments per the documentation standards.

Includes minor code layout fixes for better readability.

See #48303.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/phpcs.xml.dist

    r47035 r47122  
    2121    <arg name="parallel" value="20"/>
    2222
    23     <!-- Show sniff codes in all reports -->
     23    <!-- Show sniff codes in all reports. -->
    2424    <arg value="ps"/>
    2525
     
    4949        <properties>
    5050            <property name="customPropertiesWhitelist" type="array">
    51                 <!-- From database structure queries -->
     51                <!-- From database structure queries. -->
    5252                <element value="Collation"/>
    5353                <element value="Column_name"/>
     
    6363                <element value="Sub_part"/>
    6464                <element value="Type"/>
    65                 <!-- From plugin/theme data -->
     65                <!-- From plugin/theme data. -->
    6666                <element value="authorAndUri"/>
    6767                <element value="Name"/>
    6868                <element value="Version"/>
    69                 <!-- From the result of wp_xmlrpc_server::wp_getPageList() -->
     69                <!-- From the result of wp_xmlrpc_server::wp_getPageList(). -->
    7070                <element value="dateCreated"/>
    7171
    72                 <!-- From DOMDocument -->
     72                <!-- From DOMDocument. -->
    7373                <element value="childNodes"/>
    7474                <element value="formatOutput"/>
     
    7878                <element value="preserveWhiteSpace"/>
    7979                <element value="textContent"/>
    80                 <!-- From PHPMailer -->
     80                <!-- From PHPMailer. -->
    8181                <element value="AltBody"/>
    8282                <element value="Body"/>
     
    9090                <element value="Sender"/>
    9191                <element value="Subject"/>
    92                 <!-- From PHPUnit_Util_Getopt -->
     92                <!-- From PHPUnit_Util_Getopt. -->
    9393                <element value="longOptions"/>
    94                 <!-- From POP3 -->
     94                <!-- From POP3. -->
    9595                <element value="ERROR"/>
    96                 <!-- From ZipArchive -->
     96                <!-- From ZipArchive. -->
    9797                <element value="numFiles"/>
    9898            </property>
     
    103103    <exclude-pattern type="relative">^build/*</exclude-pattern>
    104104
    105     <!-- Directories and third party library exclusions -->
     105    <!-- Directories and third party library exclusions. -->
    106106    <exclude-pattern>/node_modules/*</exclude-pattern>
    107107    <exclude-pattern>/vendor/*</exclude-pattern>
     
    141141    <exclude-pattern>/tests/phpunit/includes/speed-trap-listener\.php</exclude-pattern>
    142142
    143     <!-- Test data and fixtures -->
     143    <!-- Test data and fixtures. -->
    144144    <exclude-pattern>/tests/phpunit/build*</exclude-pattern>
    145145    <exclude-pattern>/tests/phpunit/data/*</exclude-pattern>
     
    215215        <properties>
    216216            <property name="custom_test_class_whitelist" type="array">
    217                 <!-- Test case parent classes -->
     217                <!-- Test case parent classes. -->
    218218                <element value="WP_UnitTestCase"/>
    219219                <element value="WP_Ajax_UnitTestCase"/>
     
    230230                <element value="Tests_Query_Conditionals"/>
    231231
    232                 <!-- Mock classes -->
     232                <!-- Mock classes. -->
    233233                <element value="Spy_REST_Server"/>
    234234                <element value="WP_REST_Test_Controller"/>
     
    239239                <element value="WP_Object_Cache"/>
    240240
    241                 <!-- PHPUnit helpers -->
     241                <!-- PHPUnit helpers. -->
    242242                <element value="TracTickets"/>
    243243                <element value="WP_PHPUnit_Util_Getopt"/>
     
    271271    </rule>
    272272
    273     <!-- Assignments in while conditions are a valid method of looping over iterables -->
     273    <!-- Assignments in while conditions are a valid method of looping over iterables. -->
    274274    <rule ref="WordPress.CodeAnalysis.AssignmentInCondition.FoundInWhileCondition">
    275275        <exclude-pattern>*</exclude-pattern>
     
    284284    </rule>
    285285
    286     <!-- Exclude some old classes that can't be renamed, as it would break back compat -->
     286    <!-- Exclude some old classes that can't be renamed, as it would break back compat. -->
    287287    <rule ref="PEAR.NamingConventions.ValidClassName.Invalid">
    288288        <exclude-pattern>/src/wp-admin/includes/class-wp-filesystem-ftpsockets\.php</exclude-pattern>
Note: See TracChangeset for help on using the changeset viewer.