Skip to content
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.

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

Add PHP File-Level DocBlocks Globally #791

Closed

Conversation

robfrawley
Copy link
Collaborator

@robfrawley robfrawley commented Sep 7, 2016

Add the following doc-block to all PHP files in this project:

/*
 * This file is part of the `liip/LiipImagineBundle` project.
 *
 * (c) https://github.com/liip/LiipImagineBundle/graphs/contributors
 *
 * For the full copyright and license information, please view the LICENSE.md
 * file that was distributed with this source code.
 */

This has been my file-level doc-block style of choice for quite some time (some may notice it is directly modeled after Symfony's).

That being said, I am more than open to alterations if the consensus suggests one.

@alexwilson
Copy link
Collaborator

I wonder if it's worth tagging with phpdoc annotations (@license and co)?

@robfrawley
Copy link
Collaborator Author

robfrawley commented Sep 7, 2016

Personally, I don't see too much value in adding more lines (and effective wasted horizontal space) to the header comment. I think we should keep it as simple as possible.

For example, one or the other, but not both, would be my preference:

/*
 * This file is part of the `liip/LiipImagineBundle` project.
 *
 * (c) https://github.com/liip/LiipImagineBundle/graphs/contributors
 *
 * For the full copyright and license information, please view the LICENSE.md
 * file that was distributed with this source code.
 */

or

/*
 * This file is part of the `liip/LiipImagineBundle` project.
 *
 * (c) https://github.com/liip/LiipImagineBundle/graphs/contributors
 *
 * @license MIT
 */

@alexwilson
Copy link
Collaborator

alexwilson commented Sep 7, 2016

I see your point, maybe the former is the better option as I see it's a common standard elsewhere - in which case lgtm! 👍

@robfrawley
Copy link
Collaborator Author

@lsmith77 Do you have a format preference for the file-level doc-block? Or is the submitted doc-block okaty?

@robfrawley robfrawley force-pushed the feature-file-level-docblocks branch from 59c1856 to 6c66add Compare September 9, 2016 11:58
@lsmith77
Copy link
Contributor

lsmith77 commented Sep 9, 2016

fine for me ..

@lsmith77 lsmith77 added the State: Reviewing This item is being reviewed to determine if it should be accepted. label Sep 13, 2016
@robfrawley
Copy link
Collaborator Author

@lsmith77 This is going to become quite a pain to merge as files are updated/removed/added, so I'm not going to constantly re-base it as other changes are merged. Instead, just give me a shout whenever you decide to merge this if it needs a re-base and I'll handle it once, right away.

@robfrawley
Copy link
Collaborator Author

Closing in favor of #800 now that #792 has been merged.

@robfrawley robfrawley closed this Sep 19, 2016
@lsmith77 lsmith77 removed the State: Reviewing This item is being reviewed to determine if it should be accepted. label Sep 19, 2016
@robfrawley robfrawley deleted the feature-file-level-docblocks branch January 28, 2017 05:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants