Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Already on GitHub? Sign in to your account

[Routing] added more phpdoc and replaced 'array of type' by 'Type[]' #5994

Merged
merged 3 commits into from Nov 13, 2012

Conversation

Projects
None yet
3 participants
Member

Tobion commented Nov 12, 2012

No description provided.

@fabpot fabpot commented on the diff Nov 12, 2012

...ny/Component/Routing/Loader/AnnotationClassLoader.php
protected $reader;
+
+ /**
@fabpot

fabpot Nov 12, 2012

Owner

What's the benefit of adding this? I understand when it is an object, but here, this has little value.

@Tobion

Tobion Nov 12, 2012

Member

Just more "explicitness". And it looks bad, when one property is documented and the other not.

Member

Tobion commented Nov 12, 2012

@fabpot you should squash with your great merging tool ;)

@henrikbjorn henrikbjorn commented on the diff Nov 12, 2012

...Component/Routing/Matcher/Dumper/DumperCollection.php
private $parent;
+
+ /**
+ * @var (DumperCollection|DumperRoute)[]
@henrikbjorn

henrikbjorn Nov 12, 2012

Contributor

This looks wierd wouldnt the correct way be DumperCollection[]|DumperRoute[]

@Tobion

Tobion Nov 12, 2012

Member

No, its an array of DumperCollection and DumperRoute instances. Not an array of DumperCollection or an array of DumperRoute.
Its also in the spec: see http://www.phpdoc.org/docs/latest/for-users/types.html?highlight=array

fabpot added a commit that referenced this pull request Nov 13, 2012

merged branch Tobion/routing-phpdoc (PR #5994)
This PR was merged into the master branch.

Commits
-------

50e41d2 one space too much
5d9a36f small fix and enhancement
1e1cb13 [Routing] added more phpdoc and  replaced 'array of type' by 'Type[]'

Discussion
----------

[Routing] added more phpdoc and  replaced 'array of type' by 'Type[]'

---------------------------------------------------------------------------

by Tobion at 2012-11-12T17:03:01Z

@fabpot you should squash with your great merging tool ;)

@fabpot fabpot merged commit 50e41d2 into symfony:master Nov 13, 2012

1 check failed

default The Travis build failed
Details

fabpot added a commit that referenced this pull request Nov 19, 2012

merged branch raziel057/COMPONENT_Form (PR #5888)
This PR was squashed before being merged into the master branch (closes #5888).

Commits
-------

2379d86 CS Fixes - Replaced "array of type" by "Type[]" in PHPDoc block

Discussion
----------

CS Fixes - Replaced "array of type" by "Type[]" in PHPDoc block

Bug fix: no
Feature addition: no
Backwards compatibility break: no
Symfony2 tests pass: no (but tests doesn't pass on master too). See Travis.
License of the code: MIT
Documentation PR: Not Applicable
Status: Finished

To improve support of the eclipse PDT pluggin (for autocompletion), I propose to change the array notation in PHPDoc blocks to match the phpDocumentor notation for "array of type".

Modifications are made for the following components:
- BrowserKit
- ClassLoader
- Config
- Console
- CssSelector
- DependencyInjection
- DomCrawler
- EventDispatcher (no changes)
- Filesystem (no changes)
- Finder
- Form
- HttpFoundation
- HttpKernel
- Locale
- OptionResolver (no changes)
- Process (no changes)
- Routing (no changes)
- Serializer (no changes)
- Templating
- Translation
- Validator
- Yaml (no changes)
- Security
- Stopwatch (no changes)

See Proposal #5852

---------------------------------------------------------------------------

by pborreli at 2012-11-01T15:19:27Z

will you make a PR for each component ? why not only one PR with one commit for each component instead ?

---------------------------------------------------------------------------

by raziel057 at 2012-11-01T15:32:39Z

Ok, I'm going try to do it.

---------------------------------------------------------------------------

by raziel057 at 2012-11-01T16:12:56Z

I would like to rename my branch from COMPONENT_Form to changes-phpdoc (as all modifications would be commited in only one branch), so I tried to execute the following command but I have an error.

git remote rename COMPONENT_Form changes-phpdoc
error: Could not rename config section 'remote.COMPONENT_Form' to 'remote.changes-phpdoc'

Do you know how to do it?

---------------------------------------------------------------------------

by pborreli at 2012-11-01T16:14:26Z

don't rename it, you will have to close and make another PR which is useless here, just edit the title.

---------------------------------------------------------------------------

by stof at 2012-11-01T16:16:17Z

and ``git remote rename`` is about renaming a remote repo, not a branch

---------------------------------------------------------------------------

by raziel057 at 2012-11-03T11:36:02Z

Is it normal that all my commit are duplicated? I would like just update my master and merge with my branch.

---------------------------------------------------------------------------

by fabpot at 2012-11-06T10:22:55Z

@raziel057 Can you rebase on master? That should fix your problem.

---------------------------------------------------------------------------

by fabpot at 2012-11-09T13:28:53Z

@raziel057 Can you finish this PR?

---------------------------------------------------------------------------

by Tobion at 2012-11-09T13:34:45Z

I'll do it for the routing component this evening because I know it by heart. ^^

---------------------------------------------------------------------------

by raziel057 at 2012-11-09T15:06:26Z

@Tobion ok Thanks!

@fabpot Yes, I will try to finish it this week end.

---------------------------------------------------------------------------

by raziel057 at 2012-11-11T13:04:07Z

@Tobion Did you already change PHPDoc in the Routing component?

---------------------------------------------------------------------------

by Tobion at 2012-11-11T15:21:18Z

@raziel057 Yes I'm working on it.

---------------------------------------------------------------------------

by Tobion at 2012-11-12T15:16:31Z

@raziel057 Done. See #5994

@ogizanagi ogizanagi referenced this pull request Jan 9, 2016

Closed

[2.7] [Routing] cs fix #17322

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment