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

Removed all @category, @package, and @subpackage annotations #3508

Closed
wants to merge 3 commits into
from

Conversation

Projects
None yet
2 participants
Owner

weierophinney commented Jan 21, 2013

  • Per #2743, and following on #2953 and discussion on the ML
  • Also removes empty docblocks, and empty lines at the end of docblocks
  • Library only; phpdoc is never run on tests anyways, and did not want to
    potentially create breakage due to test expectations that relied on
    annotations. At this time, all tests pass.

PR created using two tools:

  • sed -ri '/^ \* \@(subpackage|package|category)/d' Zend/**/*.php
  • for f in Zend/**/*.php;do php clean_empty_docblocks.php $f ; done

In the latter command, I used the following script:

<?php
$file = $argv[1];

if (!file_exists($file)) {
    echo "Could not open $file\n";
    exit(1);
}

$contents = file_get_contents($file);

// empty docblocks
$contents = preg_replace('#\n\/\*\*[ ]*\n \*\/#', '', $contents);
// trailing empty docblocks
$contents = preg_replace('#\n \*[ ]*(\n \*\/)#', '$1', $contents);
file_put_contents($file, $contents);
exit(0);

@ghost ghost assigned Maks3w Jan 21, 2013

weierophinney added a commit that referenced this pull request Jan 21, 2013

[#3485] Strip @category, @package, and @subpackage annotations
- Pre-emptive measure, in light of #3508
- Only on new files

weierophinney added some commits Jan 21, 2013

Removed all @category, @package, and @subpackage annotations
- Per #2743, and following on #2953 and discussion on the ML
- Also removes empty docblocks, and empty lines at the end of docblocks
- Library only; phpdoc is never run on tests anyways, and did not want to
  potentially create breakage due to test expectations that relied on
  annotations. At this time, all tests pass.
Remove category trait
- Was misspelled as "catagory", so my script missed it.
- also updated year to 2013
More catches from @Maks3w
- Many of the classes had malformed docblocks:

/**
* @package ...
* @subpackage ...
*/

- Some had subversion strings!
Member

Maks3w commented Jan 21, 2013

Merged c2aa18f

@Maks3w Maks3w closed this Jan 21, 2013

samsonasik added a commit to samsonasik/zf2 that referenced this pull request Oct 3, 2013

weierophinney pushed a commit to zendframework/zend-authentication that referenced this pull request May 14, 2015

weierophinney pushed a commit to zendframework/zend-mail that referenced this pull request May 14, 2015

weierophinney pushed a commit to zendframework/zend-barcode that referenced this pull request May 14, 2015

gianarb pushed a commit to zendframework/zend-captcha that referenced this pull request May 15, 2015

gianarb pushed a commit to zendframework/zend-uri that referenced this pull request May 15, 2015

gianarb pushed a commit to zendframework/zend-eventmanager that referenced this pull request May 15, 2015

gianarb pushed a commit to zendframework/zend-servicemanager that referenced this pull request May 15, 2015

gianarb pushed a commit to zendframework/zend-tag that referenced this pull request May 15, 2015

gianarb pushed a commit to zendframework/zend-debug that referenced this pull request May 15, 2015

gianarb pushed a commit to zendframework/zend-math that referenced this pull request May 15, 2015

gianarb pushed a commit to zendframework/zend-loader that referenced this pull request May 15, 2015

gianarb pushed a commit to zendframework/zend-memory that referenced this pull request May 15, 2015

gianarb pushed a commit to zendframework/zend-modulemanager that referenced this pull request May 15, 2015

gianarb pushed a commit to zendframework/zend-config that referenced this pull request May 15, 2015

gianarb pushed a commit to zendframework/zend-test that referenced this pull request May 15, 2015

gianarb pushed a commit to zendframework/zend-stdlib that referenced this pull request May 15, 2015

gianarb pushed a commit to zendframework/zend-crypt that referenced this pull request May 15, 2015

gianarb pushed a commit to zendframework/zend-paginator that referenced this pull request May 15, 2015

gianarb pushed a commit to zendframework/zend-serializer that referenced this pull request May 15, 2015

gianarb pushed a commit to zendframework/zend-i18n that referenced this pull request May 15, 2015

gianarb pushed a commit to zendframework/zend-text that referenced this pull request May 15, 2015

gianarb pushed a commit to zendframework/zend-xmlrpc that referenced this pull request May 15, 2015

gianarb pushed a commit to zendframework/zend-inputfilter that referenced this pull request May 15, 2015

gianarb pushed a commit to zendframework/zend-di that referenced this pull request May 15, 2015

gianarb pushed a commit to zendframework/zend-http that referenced this pull request May 15, 2015

gianarb pushed a commit to zendframework/zend-server that referenced this pull request May 15, 2015

gianarb pushed a commit to zendframework/zend-progressbar that referenced this pull request May 15, 2015

gianarb pushed a commit to zendframework/zend-console that referenced this pull request May 15, 2015

gianarb pushed a commit to zendframework/zend-filter that referenced this pull request May 15, 2015

gianarb pushed a commit to zendframework/zend-ldap that referenced this pull request May 15, 2015

gianarb pushed a commit to zendframework/zend-json that referenced this pull request May 15, 2015

gianarb pushed a commit to zendframework/zend-validator that referenced this pull request May 15, 2015

gianarb pushed a commit to zendframework/zend-file that referenced this pull request May 15, 2015

gianarb pushed a commit to zendframework/zend-escaper that referenced this pull request May 15, 2015

gianarb pushed a commit to zendframework/zend-dom that referenced this pull request May 15, 2015

gianarb pushed a commit to zendframework/zend-session that referenced this pull request May 15, 2015

gianarb pushed a commit to zendframework/zend-log that referenced this pull request May 15, 2015

gianarb pushed a commit to zendframework/zend-cache that referenced this pull request May 15, 2015

gianarb pushed a commit to zendframework/zend-soap that referenced this pull request May 15, 2015

gianarb pushed a commit to zendframework/zend-mime that referenced this pull request May 15, 2015

gianarb pushed a commit to zendframework/zend-view that referenced this pull request May 15, 2015

gianarb pushed a commit to zendframework/zend-navigation that referenced this pull request May 15, 2015

gianarb pushed a commit to zendframework/zend-feed that referenced this pull request May 15, 2015

weierophinney pushed a commit to zendframework/zend-permissions-acl that referenced this pull request May 15, 2015

weierophinney pushed a commit to zendframework/zend-permissions-rbac that referenced this pull request May 15, 2015

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