mirrors/barryvdh_ReflectionDocBlock
1
0
Fork 0
mirror of https://github.com/barryvdh/ReflectionDocBlock.git synced 2026-08-18 10:07:12 +00:00
Code Issues Packages Projects Releases Wiki Activity
330 Commits 7 Branches 28 Tags
e9e35284d9c11fdddd2affadeea20401a55a563a
Commit Graph
190 Commits
Author SHA1 Message Date
Mike van Riel d798405fae Implement support for Variadic arguments 
Fixes https://github.com/phpDocumentor/phpDocumentor2/issues/629, in
this commit we add support for recognizing and displaying variadic
arguments as described in the Variadics RFC on Internals
(https://wiki.php.net/rfc/variadics).

This adds support for describing Variadics even before PHP 5.6, where
this feature is planned.
 2014-03-28 10:21:30 +01:00
Siad Ardroumli 832559be31 Fixed method call. 
Related to https://github.com/phpDocumentor/phpDocumentor2/pull/1145
 2014-03-16 13:23:37 +01:00
Carsten Brandt 4922a4a286 Preserve newlines in docblock tags 
This is especially important when using markdown.
Adding a blank line between text introduces a new paragraph.
Current implementation will result in all text staying in one paragraph
and also other elements like lists and code do not get recognized in
most cases.
 2014-02-28 17:17:48 +01:00
Mike van Riel 506de88c26 Add support for Parsedown as a markdown parser 2013-12-05 09:16:55 +01:00
Barry vd. Heuvel 21148759ac Add __toString() methods for Description and Tag 
And let the Serializer make use of the (string) $tag
 2013-05-27 18:16:15 +02:00
Vasil Rangelov 5000a2878d Added "{}" around all double quoted variables, for readability's sake; 
Performance improvement in Serializer - wrap length is calculated once during the text portion only. Tags reuse the result. Also no "prefix" adding in tags - the name is simply added before wrapping.
 2013-05-27 02:04:23 +03:00
Vasil Rangelov a2aae72328 Minor doc fix at Serializer.php. 2013-05-27 01:31:58 +03:00
Vasil Rangelov 5b2b43e2a9 Added getters for Serializer options; 
Swapped the indent and indent string options at Serializer's constructor;
Renamed Serializer::setIndentFirstLine() to setIsFirstLineIndented() in accordance with the getter (PHPMD fix);
Line length is now ACTUALLY line length, i.e. it takes the indentation into account, and is applied to tags as well;
Fixed ReturnTag::setContent() to set "types" to NULL;
A lot of doc and CS fixes at Serializer.php.
 2013-05-27 01:27:07 +03:00
Barry vd. Heuvel 6ac49cd709 Revert setType 
Doesn't really belong to this PR
 2013-05-26 22:36:53 +02:00
Barry vd. Heuvel eb4ab2c720 Move serializer to seperate class 2013-05-26 22:36:31 +02:00
Barry vd. Heuvel f331d328a4 Export DocBlock & full description 
Add get/set for entire description, and create a docblock comment, based
on the description/tags
 2013-05-26 21:17:09 +02:00
Barry vd. Heuvel 3760d10ace Set return type 2013-05-26 21:16:30 +02:00
Vasil Rangelov d99732612a Added support for static method declarations at MethodTag and according unit tests. 
Fixed MethodTag::getContent() to actually return the content as opposed to $this;
 2013-05-16 22:17:15 +03:00
Vasil Rangelov 7f55602948 Adjusted Unit tests and docs to match the latest dot separation. 2013-04-16 19:25:40 +03:00
Vasil Rangelov 510159bace Fixed the dot separation to match the latest PSR 
(see phpDocumentor/phpDocumentor2#797)
 2013-04-16 17:22:15 +03:00
Jon Cave 8f7ec6bd4a Fix typo in "cotnent" 2013-02-01 18:08:30 +00:00
Vasil Rangelov 13466286b0 Added "scalar" as a recognized keyword (phpDocumentor/phpDocumentor2#694); 
Changed the list of keywords to be static (for the purpose of reducing memory consumption);
Updated composer.lock with the latest dependencies (PHPUnit in particular).
 2012-12-02 22:26:45 +02:00
Vasil Rangelov ff09e61782 Added setters at Location and Description; 
Added DocBlock::appendTag();
Minor reorganization at the tag setters;
 2012-11-30 22:37:41 +02:00
Vasil Rangelov 8223e475fa Refactored all tags to have setters for all of their components; 
Removed the special handling for VarTag (it's now equivalent to ParamTag);
Minor doc, CS and coverage fixes.
 2012-11-30 19:26:19 +02:00
Vasil Rangelov 23dedb3e10 CS fixes. 2012-11-27 19:52:28 +02:00
Vasil Rangelov bf3e86788d Added tests related to the namespaced tag support; 
Restored ReturnTag::getTypesCollection() to "protected", to avoid potential BC breaks later.
 2012-11-22 01:23:31 +02:00
Vasil Rangelov 2dbc608a51 Added support for namespaced tags; 
Simplified @see and @link parsing;
Added comments to the regexes of @method, @example and @source;
Added a test case for what 2812eac046 intended to fix.
 2012-11-22 00:37:22 +02: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 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 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