File: MultiLineDocBlockTest.inc

package info (click to toggle)
php-codesniffer 3.11.2-2
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 13,772 kB
  • sloc: php: 84,771; pascal: 10,061; xml: 6,832; javascript: 2,096; sh: 11; makefile: 4
file content (81 lines) | stat: -rw-r--r-- 1,601 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
<?php

/* testEmptyDocblock */
/**
 */

/* testMultilineDocblock */
/**
 * This is a multi-line docblock.
 *
 * With blank lines, stars, tags, and tag descriptions.
 *
 * @tagWithoutDescription
 *
 * @since 10.3
 * @deprecated 11.5
 *
 * @requires PHP 7.1 -- PHPUnit tag.
 *
 * @tag-with-dashes-is-suppported Description.
 * @tag_with_underscores          Description.
 *
 * @param string    $p1 Description 1.
 * @param int|false $p2 Description 2.
 *
 * @return void
 */
function base($p1, $p2) {}

/* testMultilineDocblockNoStars */
/****
    This is a multi-line docblock, but the lines are not marked with stars.
    Then again, the opener and closer have an abundance of stars.

    @since 10.3

    @param string    $p1 Description 1.
    @param int|false $p2 Description 2.

    @return void
 **/
function noStars($p1, $p2) {}

class Spaces {
    /* testMultilineDocblockIndented */
    /**
     * This is a multi-line indented docblock.
     *
     * With blank lines, stars, tags, and tag descriptions.
     *
     * @since 10.3
     * @deprecated 11.5
     *
     * @param string    $p1 Description 1.
     * @param int|false $p2 Description 2.
     *
     * @return void
     */
    function foo($p1, $p2) {}
}

/* testMultilineDocblockOpenerNotOnOwnLine */
/** Start of description
 * description continued.
 */

/* testMultilineDocblockCloserNotOnOwnLine */
/**
 * Start of description
 * description continued. */

/* testMultilineDocblockStarsNotAligned */
/**
* Start of description.
*   Line below this is missing a star.

   Text

    * Star indented.
    * Closer indented.
    */