mirrors/barryvdh_ReflectionDocBlock
1
0
Fork 0
mirror of https://github.com/barryvdh/ReflectionDocBlock.git synced 2026-08-18 18:13:13 +00:00
Code Issues Packages Projects Releases Wiki Activity
188 Commits 7 Branches 28 Tags
66c45cf480229d659bdb1d28ed9645f5e5a25155
Commit Graph
188 Commits
This Branch
This Branch
All Branches
Author SHA1 Message Date
Vasil Rangelov 3e91fb4071 Merge pull request #13 from boenrobot/location 
Abstracting away namespace (and other context dependent) information into a new object
 2012-11-21 12:36:31 -08:00
Vasil Rangelov 8bb304309c Introduced Context and Location, and adapted Collection and ReturnTag accordingly. 2012-11-21 15:55:10 +02:00
Vasil Rangelov a4b899e96c Reverted the move of explode() into Return, and moved the implode() into Collection's new __toString() method instead; 
Also had to made type resolution lazy, as a pleasant side effect.

This reverts commit db20ae39fb.
 2012-11-18 18:50:45 +02:00
Vasil Rangelov cee63f991d Revert "Merge pull request #10 from boenrobot/author" 
This reverts commit 21c36677ab, reversing
changes made to ffcaa03337.
 2012-11-18 17:15:48 +02:00
Vasil Rangelov 8df7e5fb6b Removed redundant preg_split from SourceTag (mistakenly pasted from ReturnTag). 2012-11-17 17:32:48 +02:00
Vasil Rangelov c33dc9e7d7 Merge pull request #10 from boenrobot/author 
Introduced role, description and space separated URIs to the author tag.
 2012-11-17 06:33:38 -08:00
Vasil Rangelov 77d0359016 Merge pull request #12 from boenrobot/source-and-example 
Reflections for @source and @example
 2012-11-17 05:23:56 -08:00
Vasil Rangelov 86c72b291a Added @example tag handler, and registered it and @source at Tag. 2012-11-17 15:23:16 +02:00
Vasil Rangelov c70be2a745 Added reflection for @source tag. 2012-11-17 15:16:56 +02:00
Vasil Rangelov 29dcb18b95 Merge pull request #11 from boenrobot/version-and-derivatives 
Reflections for @version, @since and @deprecated
 2012-11-17 05:13:04 -08:00
Vasil Rangelov 44cf524dcf Simplified ReturnTag parsing. 2012-11-16 21:53:17 +02:00
Vasil Rangelov a4855850d3 Moved the type separation into ReturnTag, for consistency with the type merging that is currently there. 2012-11-16 21:43:25 +02:00
Vasil Rangelov 63a8fb34d4 Added a limit on Collection's explode(), thus (insignificantly, but still) improving performance. 2012-11-14 22:42:56 +02:00
Vasil Rangelov 09b2cb083d Fixed DocBlock giving and reception for long descriptions. 2012-11-14 18:05:03 +02:00
Vasil Rangelov 3bfb48da76 Doc updates and fixes. 2012-11-13 21:50:56 +02:00
Vasil Rangelov 92572a9982 Updated @author in accordance with the latest changes. 2012-11-13 19:23:42 +02:00
Vasil Rangelov 532fb040ab Merge branch 'master' of github.com:boenrobot/ReflectionDocBlock into author 
Conflicts:
	src/phpDocumentor/Reflection/DocBlock/Tag/AuthorTag.php
 2012-11-13 19:13:34 +02:00
Vasil Rangelov fc53ad4139 Updated @version in accordance with the latest changes in Tag. 2012-11-13 19:10:13 +02:00
Vasil Rangelov 3d8bcdbe5b Merge branch 'master' of github.com:boenrobot/ReflectionDocBlock into version-and-derivatives 2012-11-13 19:05:14 +02:00
Vasil Rangelov 878e24d40d Made all tag handlers call Tag::__construct() rather than "manually" duplicating it; 
Tag::__construct() trims the description (as is common for most tag handlers), while the original contents is still in the $content property;
Added the DocBlock argument to all tag handlers.
 2012-11-13 19:00:49 +02:00
Vasil Rangelov 903722e389 Renamed LongDescription to Description, to better serve its new dual role as "holder for a place where inline tags can occur"; 
Removed Tag::setDocblock() in favor of an additional constructor argument that defaults to NULL;
Tag::createInstance() and Description's constructor now have a second argument, allowing the specification of an owning DocBlock;
Description::getParsedContents() assigns the Description's owning DocBlock object when creating tags.
 2012-11-13 17:16:30 +02:00
Vasil Rangelov ea62320415 Tweaked the "testInvalidTagBlock" test to appease PHPCS (though strictly speaking, this is a bug with PHPCS "NEWDOC" handling). 2012-11-13 16:43:36 +02:00
Vasil Rangelov 8107678560 Added reflections for @version, @since and @deprecated, which separate the version vector (if one is provided) from the description. 2012-11-13 15:28:17 +02:00
Vasil Rangelov 6602ce0375 @return now trims the content before splitting it; 
Removed ThrowTag.php (unnecessary, given the map, which aliases "throw" to ThrowsTag.php);
Added tests for ThrowsTag, along with a few other minor test additions and fixes;
 2012-11-11 19:51:04 +02:00
Vasil Rangelov 2348c16485 Applied multi line fixes to @param, analogous to those in @return. 2012-11-11 17:45:16 +02:00
Vasil Rangelov b802727676 Minor syntax and doc fixes at Tag::registerTagHandler(); 
Split the "testTagHandlerRegistration" test into several new ones, with appropriate @covers annotations added;
Although not required for single liners, class names at the built in tag handlers map are indented on a separate line for readability.
 2012-11-11 15:20:59 +02:00
Vasil Rangelov 08dc71ba37 Refactored Tag::createInstance() to use a simple tag-to-class map, that has the default tag handlers pre-registered. 2012-11-11 00:54:51 +02:00
Vasil Rangelov d73444f859 Minor doc fixes. 2012-11-10 23:45:28 +02:00
Vasil Rangelov f11936eaae Removed DocBlock::expandType() and associated tests, as previously advised by @mvriel; 
Added tests for generic Tag objects, and a few others;
Increased total coverage by more appropriate use of @covers annotations.
 2012-11-10 23:19:36 +02:00
Vasil Rangelov 6e1bb192b3 Inverted @param and @return hierarchy; 
More fixes to tests and code coverage increase.
 2012-11-10 20:27:57 +02:00
Vasil Rangelov 038a5f3150 Introduced role, description and space separated URIs to the author tag. 2012-11-10 16:50:39 +02:00
Vasil Rangelov ad32c225c5 Updated tag doc comments. 2012-11-10 14:18:40 +02:00
Vasil Rangelov ca90350e36 Made the Tag::createInstance() create generic tag objects when there are uppercase letters in the tag name 
(this fixes phpDocumentor/phpDocumentor2#672).
 2012-11-10 14:00:01 +02:00
Vasil Rangelov 19a9124274 Increased unit test coverage of DocBlock; 
Moved the tag block checks outside (and prior to) the tag line loop;
Doc and CS fixes.
 2012-11-10 13:24:46 +02:00
Vasil Rangelov 1a5e882877 Merge pull request #9 from boenrobot/LongDescription 
Nested inline tag parsing
 2012-11-10 01:52:46 -08:00
Vasil Rangelov d58be52929 Merge branch 'LongDescription' of github.com:boenrobot/ReflectionDocBlock into LongDescription 2012-11-10 11:51:40 +02:00
Vasil Rangelov 348177c938 Improved performance, thanks to @nikic's new regex. 2012-11-10 11:49:23 +02:00
Vasil Rangelov 66b35473ec Added escape sequences that allow "literal" inline tags in descriptions. 2012-11-10 11:49:23 +02:00
Vasil Rangelov 4bb2c04673 Implemented nested inline tag parsing; 
Added unit tests for LongDescription.php;
Added the "src" folder as white listed for code coverage in the PHPUnit configuration;
Fixed the @covers annotation inside the CoversTagTest.php (isn't this ironic?).
 2012-11-10 11:49:23 +02:00
Vasil Rangelov 36b46b9769 Merge pull request #8 from boenrobot/CS 
Coding standard fixes.
 2012-11-10 01:40:09 -08:00
Vasil Rangelov df67eaf0be Restored indentation in multi-line tag descriptions, and applied them where they were previously missing. 2012-11-05 23:14:32 +02:00
Vasil Rangelov 6bc655072f Improved performance, thanks to @nikic's new regex. 2012-11-05 17:50:11 +02:00
Vasil Rangelov f7457e64bf Added escape sequences that allow "literal" inline tags in descriptions. 2012-11-04 23:45:55 +02:00
Vasil Rangelov e04f25a77b Shortened some long variable names in the test suite, as advised by PHPMD's default settings. 2012-11-04 23:34:25 +02:00
Vasil Rangelov d31a33e846 Implemented nested inline tag parsing; 
Added unit tests for LongDescription.php;
Added the "src" folder as white listed for code coverage in the PHPUnit configuration;
Fixed the @covers annotation inside the CoversTagTest.php (isn't this ironic?).
 2012-11-04 22:29:38 +02:00
Vasil Rangelov 54f30f83b6 Updated comments with the namespaced notation, and added the "Tag" suffix where needed. 2012-11-04 22:19:18 +02:00
Vasil Rangelov bb189b87bd Made PSR2 related fixes that are compatible with the PEAR coding standard. 2012-11-04 16:02:57 +02:00
Vasil Rangelov 9ea3275389 Tons of coding standard fixes. 2012-11-04 15:16:37 +02:00
Mike van Riel 0701e60839 Change behaviour of @param parsing 
In issue report phpDocumentor/phpDocumentor2#620 @bobef reported that when he
used just a Type as content of the @param that it would be recognized as
description instead of the Type.

According to the unit tests this is correct behaviour but after reviewing the
pattern of the output his version is more consistent. As such I have altered
the behaviour to act as following:

If only one word is found after an @param (word means white-space bounded
series of characters) then interpret that as the type and not description.

During this item several issues in unit tests were fixed and a new 'Type'
Collection was introduced that is capable of expanding types based on a given
namespace and series of aliases.
This should be re-used in phpDocumentor's Transformer as a duplication exists
there with the expanding of the Types.

Please note: the suggested format by @bobef is not valid according to the
PHPDoc Standard but is provided for convenience.
 2012-11-03 22:14:43 +01:00
Mike van Riel b3641c0e69 Merge branch 'patch-2' of https://github.com/boenrobot/ReflectionDocBlock into boenrobot-patch-2 
Conflicts:
	src/phpDocumentor/Reflection/DocBlock/LongDescription.php
 2012-11-01 18:56:36 +01:00