8000 [SecurityBundle] Add Docs for SecurityFactoryInterface · Issue #10870 · symfony/symfony · GitHub
[go: up one dir, main page]
Skip to content

[SecurityBundle] Add Docs for SecurityFactoryInterface #10870

New issue

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

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Closed
ghost opened this issue May 8, 2014 · 2 comments
Closed

[SecurityBundle] Add Docs for SecurityFactoryInterface #10870

ghost opened this issue May 8, 2014 · 2 comments
Labels
Enhancement Good first issue Ideal for your first contribution! (some Symfony experience may be required) SecurityBundle

Comments

@ghost
Copy link
ghost commented May 8, 2014

The methods of the SecurityFactoryInterface do not have any comments. It would be helpfull if there were comments describing how the methods should be implemented and how the are used.

http://symfony.com/doc/2.3/cookbook/security/custom_authentication_provider.html
is describing the Interface a bit, but especially the signature of the create method is unclear.
@ghost ghost added the SecurityBundle label Jun 16, 2014
@fabpot
Copy link
Member
fabpot commented Dec 24, 2014

This is more something for the docs than Symfony itself. Closing.

@fabpot fabpot closed this as completed Dec 24, 2014
@xabbuh xabbuh mentioned this issue Dec 29, 2014
Closed
@wouterj
Copy link
Member
wouterj commented May 3, 2015

I believe this is also a code issue, a very important one. The interface doesn't have PHPDocs, making it very hard to understand it. While the docs can help with this, PHPDoc should also be enough for experienced users to know what to do.

At the moment, one has to find implementations of the interface to know what the methods should do or what the arguments mean and what should be returned.

I would vote to reopen this issue

@fabpot fabpot reopened this May 3, 2015
@javiereguiluz javiereguiluz added the Good first issue Ideal for your first contribution! (some Symfony experience may be required) label Feb 12, 2016
@aminemat aminemat mentioned this issue Mar 12, 2016
Closed
nicolas-grekas added a commit that referenced this issue Mar 15, 2016
@nicolas-grekas
minor #18114 [SecurityBundle][PHPDoc] Added method doumentation for S…
afd31da 
…ecurityFactor… (aminemat)

This PR was submitted for the master branch but it was merged into the 2.3 branch instead (closes #18114).

Discussion
----------

[SecurityBundle][PHPDoc] Added method doumentation for SecurityFactor…

| Q             | A
| ------------- | ---
| Branch        | 2.7
| Bug fix?      | no
| New feature?  | no
| BC breaks?    | no
| Deprecations? | no
| Tests pass?   | yes
| Fixed tickets | #10870
| License       | MIT
| Doc PR        |

Commits
-------

cfb3ea1 [SecurityBundle][PHPDoc] Added method doumentation for SecurityFactoryInterface
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
Enhancement Good first issue Ideal for your first contribution! (some Symfony experience may be required) SecurityBundle
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
4 participants
@fabpot @javiereguiluz @nicolas-grekas @wouterj
0