Description spanning\nmultiple lines
\n", []], ], [ <<<'COMMENT' /** * Description including * * a code block */ COMMENT , ["Description including
\n\na code block\nIndented
\n", []], ], [ <<<'COMMENT' /** * @tag Content */ COMMENT , ['', ['tag' => ['Content']]], ], [ <<<'COMMENT' /** * @tag Multiple * @tag Tags */ COMMENT , ['', ['tag' => ['Multiple', 'Tags']]], ], [ <<<'COMMENT' /** * Description with tag * @tag Content */ COMMENT , [ "Description with tag
\n", ['tag' => ['Content']], ], ], [ <<<'COMMENT' /** * @trailingspace */ COMMENT , ['', ['trailingspace' => ['']]], ], [ <<<'COMMENT' /** * @tag Content that spans * multiple lines */ COMMENT , [ '', ['tag' => ["Content that spans\nmultiple lines"]], ], ], [ <<<'COMMENT' /** * @tag Content that spans * multiple lines indented */ COMMENT , [ '', ['tag' => ["Content that spans\n multiple lines indented"]], ], ], ]; } /** * @covers Kohana_Kodoc::parse * * @dataProvider provider_parse_basic * * @param string $comment Argument to the method * @param array $expected Expected result */ public function test_parse_basic($comment, $expected) { $this->assertSame($expected, Kodoc::parse($comment)); } public function provider_parse_tags() { $route_api = Route::get('docs/api'); return [ [ <<<'COMMENT' /** * @access public */ COMMENT , ['', []], ], [ <<<'COMMENT' /** * @copyright Some plain text */ COMMENT , ['', ['copyright' => ['Some plain text']]], ], [ <<<'COMMENT' /** * @copyright (c) 2008-2017 Kohana Team */ COMMENT , ['', ['copyright' => ['© 2008-2017 Kohana Team']]], ], [ <<<'COMMENT' /** * @license Kohana */ COMMENT , ['', ['license' => ['Kohana']]], ], [ <<<'COMMENT' /** * @license http://kohanaframework.org/license */ COMMENT , ['', ['license' => ['http://kohanaframework.org/license']]], ], [ <<<'COMMENT' /** * @link http://kohanaframework.org */ COMMENT , ['', ['link' => ['http://kohanaframework.org']]], ], [ <<<'COMMENT' /** * @link http://kohanaframework.org Description */ COMMENT , ['', ['link' => ['Description']]], ], [ <<<'COMMENT' /** * @see MyClass */ COMMENT , [ '', [ 'see' => [ 'MyClass', ], ], ], ], [ <<<'COMMENT' /** * @see MyClass::method() */ COMMENT , [ '', [ 'see' => [ 'MyClass::method()', ], ], ], ], [ <<<'COMMENT' /** * @throws Exception */ COMMENT , [ '', [ 'throws' => [ 'Exception', ], ], ], ], [ <<<'COMMENT' /** * @throws Exception During failure */ COMMENT , [ '', [ 'throws' => [ 'Exception During failure', ], ], ], ], [ <<<'COMMENT' /** * @uses MyClass */ COMMENT , [ '', [ 'uses' => [ 'MyClass', ], ], ], ], [ <<<'COMMENT' /** * @uses MyClass::method() */ COMMENT , [ '', [ 'uses' => [ 'MyClass::method()', ], ], ], ], ]; } /** * @covers Kohana_Kodoc::format_tag * @covers Kohana_Kodoc::parse * * @dataProvider provider_parse_tags * * @param string $comment Argument to the method * @param array $expected Expected result */ public function test_parse_tags($comment, $expected) { $this->assertSame($expected, Kodoc::parse($comment)); } /** * Provides test data for test_transparent_classes * @return array */ public function provider_transparent_classes() { return [ // Kohana_Core is a special case ['Kohana','Kohana_Core',NULL], ['Controller_Template','Kohana_Controller_Template',NULL], ['Controller_Template','Kohana_Controller_Template', ['Kohana_Controller_Template'=>'Kohana_Controller_Template', 'Controller_Template'=>'Controller_Template'] ], [FALSE,'Kohana_Controller_Template', ['Kohana_Controller_Template'=>'Kohana_Controller_Template']], [FALSE,'Controller_Template',NULL], ]; } /** * Tests Kodoc::is_transparent * * Checks that a selection of transparent and non-transparent classes give expected results * * @group kohana.userguide.3529-configurable-transparent-classes * @dataProvider provider_transparent_classes * @param mixed $expected * @param string $class * @param array $classes */ public function test_transparent_classes($expected, $class, $classes) { $result = Kodoc::is_transparent($class, $classes); $this->assertSame($expected,$result); } }