DocCommentUnitTest.inc in Coder 8.3.x

File

tests/Drupal/Commenting/DocCommentUnitTest.inc

<?php

/**
 * This doc comment ends in a dot, but has some white space after it.
 */

/**
 *  Separate @param, @return, @throws sections by a blank line.
 *
 * @param string $param
 *   Something incredibly useful.
 * @return bool
 *   Returns FALSE.
 * @throws Exception
 *   Thrown when $param is TRUE.
 * @ingroup sniffer
 * @deprecated
 * @see some_function()
 * @todo Fix coding standards.
 */
function test7($param) {
  if ($param) {
    throw new Exception();
  }
  return FALSE;
}

/**
 *No space before the short description.
 */
function test8() {
}

/**
 * starting lower case and no dot at the end
 */
function test9() {
}

/**
 * Short description ok.
 *
 * long description starting lower case.
 */
function test10() {
}
class Test {

  /**
   * No newline required between tag groups except @param, @return, @throws.
   *
   * @see some_function()
   * @todo Fix coding standards.
   */
  public function test() {
  }

}

/**
 * Short description.
 *
 * Long description without full stop
 */
function test11() {
}

/**
 * Long description will start with a number below.
 *
 * 64KB ought to be enough for anybody.
 */
function test12() {
}

/**
 * Creates an organisation with data provided in a table.
 *
 * Table format:
 * @codingStandardsIgnoreStart
 * | name              | chairman         | founder                 | founding year | motto                                  |
 * | City Watch        | Sir Samuel Vimes | King Veltrick I         | 1561 UC       | Fabricati Diem, Pvncti Agvnt Celeriter |
 * | Assassin's Guild  | Lord Downey      | Sir Gyles de Munforte   | 1512 AM       | Nil Mortifi, Sine Lvcre                |
 * | Unseen University | Mustrum Ridcully | Alberto Malich the Wise | 1281 AM       | Nvnc Id Vides, Nvnc Ne Vides           |
 * @codingStandardsIgnoreEnd
 *
 * @param TableNode $organisation_table
 *   The organisation data.
 *
 * @Given (the following )organisations:
 */
function givenOrganisations(TableNode $organisation_table) {
}

/**+
 * This has a typo after the comment start.
 */
function test13() {
}

/**
 * Some short comment.
 *
 * @param array $matches
 *   An array of matches by a preg_replace_callback() call that scans for
 *   @import-ed CSS files, except for external CSS files.
 * @param array $sub_key
 *   An array containing the sub-keys specifying the library asset, e.g.
 *   @code['js']@endcode or @code['css', 'component']@endcode
 * @param string $to
 *   The email address or addresses where the message will be sent to. The
 *   formatting of this string will be validated with the
 *   @link http://php.net/manual/filter.filters.validate.php PHP email @endlink.
 */
function test14(array $matches, array $sub_key, $to) {
}

Functions

Name	Description
givenOrganisations	Creates an organisation with data provided in a table.
test10	Short description ok.
test11	Short description.
test12	Long description will start with a number below.
test13
test14	Some short comment.
test7 Deprecated	Separate @param, @return,
test8	No space before the short description.
test9	starting lower case and no dot at the end

Classes

Name	Description
Test