mirrors/barryvdh_ReflectionDocBlock
1
0
Fork 0
mirror of https://github.com/barryvdh/ReflectionDocBlock.git synced 2026-08-18 01:57:13 +00:00
Code Issues Packages Projects Releases Wiki Activity
89 Commits 7 Branches 28 Tags
99de44e96f5e7dc35f1ed14fc30cd0d960e80f38
Commit Graph
89 Commits
This Branch
This Branch
All Branches
Author SHA1 Message Date
Chuck Burgess 99de44e96f tighten up dist file 2012-11-21 15:08:31 -06:00
Vasil Rangelov b20c7da00b 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 99054d341f Introduced Context and Location, and adapted Collection and ReturnTag accordingly. 2012-11-21 15:55:10 +02:00
Vasil Rangelov 9da4a65065 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 39faeec91d 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 0c15eb99f5 Removed redundant preg_split from SourceTag (mistakenly pasted from ReturnTag). 2012-11-17 17:32:48 +02:00
Vasil Rangelov 21c36677ab 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 ffcaa03337 Merge pull request #12 from boenrobot/source-and-example 
Reflections for @source and @example
 2012-11-17 05:23:56 -08:00
Vasil Rangelov 37810ef836 Added @example tag handler, and registered it and @source at Tag. 2012-11-17 15:23:16 +02:00
Vasil Rangelov 587406073d Added reflection for @source tag. 2012-11-17 15:16:56 +02:00
Vasil Rangelov aed654aa85 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 2812eac046 Simplified ReturnTag parsing. 2012-11-16 21:53:17 +02:00
Vasil Rangelov db20ae39fb 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 cdaa97eb31 Added a limit on Collection's explode(), thus (insignificantly, but still) improving performance. 2012-11-14 22:42:56 +02:00
Vasil Rangelov 27bdc08a1e Fixed DocBlock giving and reception for long descriptions. 2012-11-14 18:05:03 +02:00
Vasil Rangelov a18985a888 Doc updates and fixes. 2012-11-13 21:50:56 +02:00
Vasil Rangelov 747e6d7cdf Updated @author in accordance with the latest changes. 2012-11-13 19:23:42 +02:00
Vasil Rangelov c2f692140f 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 8eb596c1cc Updated @version in accordance with the latest changes in Tag. 2012-11-13 19:10:13 +02:00
Vasil Rangelov 26e2eade91 Merge branch 'master' of github.com:boenrobot/ReflectionDocBlock into version-and-derivatives 2012-11-13 19:05:14 +02:00
Vasil Rangelov 1ac9106c48 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 1352ef56a6 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 6df31db139 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 829a92e5aa 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 04936a7b39 @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 ae82b8488f Applied multi line fixes to @param, analogous to those in @return. 2012-11-11 17:45:16 +02:00
Vasil Rangelov bae65d2afe 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 28df2a4cd6 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 fedcd8cf49 Minor doc fixes. 2012-11-10 23:45:28 +02:00
Vasil Rangelov a868c60f8e 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 e6d2ec7c54 Inverted @param and @return hierarchy; 
More fixes to tests and code coverage increase.
 2012-11-10 20:27:57 +02:00
Vasil Rangelov f19dac185a Introduced role, description and space separated URIs to the author tag. 2012-11-10 16:50:39 +02:00
Vasil Rangelov 0ba0ad6b42 Updated tag doc comments. 2012-11-10 14:18:40 +02:00
Vasil Rangelov 8b9591a7c5 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 082c9354d0 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 233e4b3ff7 Merge pull request #9 from boenrobot/LongDescription 
Nested inline tag parsing
 2012-11-10 01:52:46 -08:00
Vasil Rangelov d788b51755 Merge branch 'LongDescription' of github.com:boenrobot/ReflectionDocBlock into LongDescription 2012-11-10 11:51:40 +02:00
Vasil Rangelov bbd5775f1f Improved performance, thanks to @nikic's new regex. 2012-11-10 11:49:23 +02:00
Vasil Rangelov 044ebd68c9 Added escape sequences that allow "literal" inline tags in descriptions. 2012-11-10 11:49:23 +02:00
Vasil Rangelov e0a5a75364 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 607aa79601 Merge pull request #8 from boenrobot/CS 
Coding standard fixes.
 2012-11-10 01:40:09 -08:00
Vasil Rangelov a4107acb6d 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 34eabb7d11 Improved performance, thanks to @nikic's new regex. 2012-11-05 17:50:11 +02:00
Vasil Rangelov f07ab7eda0 Added escape sequences that allow "literal" inline tags in descriptions. 2012-11-04 23:45:55 +02:00
Vasil Rangelov d6119709ba 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 21ec090933 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 ba1395e42d Updated comments with the namespaced notation, and added the "Tag" suffix where needed. 2012-11-04 22:19:18 +02:00
Vasil Rangelov 9a3c6f50ef Made PSR2 related fixes that are compatible with the PEAR coding standard. 2012-11-04 16:02:57 +02:00
Vasil Rangelov 009237bad2 Tons of coding standard fixes. 2012-11-04 15:16:37 +02:00
Mike van Riel 6b707f7166 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.
1.0.3 		2012-11-03 22:14:43 +01:00