Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP

Loading…

Fix @package/@subpackage to account for namespace support in PhpDocumentor #2743

Closed
localheinz opened this Issue · 3 comments

2 participants

@localheinz

PhpDocumentor2 supports - in addition to _(which is currently used) - \ as separators for @packageand @subpackage tags.

For reference, see

Therefore, as proposed and (sort of) discussed on the mailing list (see here Matthew's comment):

Package should typically be the component namespace: Zend\Loader or
Zend_Loader (the latter is what we primarily use currently, but is up
for debate, as you've noted!).

Subpackage should be the subpackage name, without the parent
namespace:

Storage (good)
Zend_Cache_Storage (bad)

If the subpackage is a further subnamespace, that's okay:

Storage\Adapter
or
Storage_Adapter

the values for these tags should be adjusted.

I proposed to take care of this.

@localheinz

Currently working on this.

@localheinz

I haven't had the time yet to take care of this. If someone else would like to jump in, go ahead.

@Maks3w
Collaborator

Duplicated with #2743

@Maks3w Maks3w closed this
@weierophinney weierophinney referenced this issue from a commit in weierophinney/zf2
@weierophinney weierophinney 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.
b8b7bbd
@weierophinney weierophinney referenced this issue from a commit in weierophinney/zf2
@weierophinney weierophinney 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.
34e8b5e
@ghost Unknown referenced this issue from a commit
@weierophinney weierophinney 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.
cd769ec
@weierophinney weierophinney referenced this issue from a commit
Commit has since been removed from the repository and is no longer available.
@weierophinney weierophinney referenced this issue from a commit in zendframework/zend-authentication
@weierophinney weierophinney Removed all @category, @package, and @subpackage annotations
- Per zendframework/zf2#2743, and following on zendframework/zf2#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.
30dceb6
@weierophinney weierophinney referenced this issue from a commit in zendframework/zend-mail
@weierophinney weierophinney Removed all @category, @package, and @subpackage annotations
- Per zendframework/zf2#2743, and following on zendframework/zf2#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.
92c4377
@weierophinney weierophinney referenced this issue from a commit
Commit has since been removed from the repository and is no longer available.
@weierophinney weierophinney referenced this issue from a commit
Commit has since been removed from the repository and is no longer available.
@weierophinney weierophinney referenced this issue from a commit in zendframework/zend-barcode
@weierophinney weierophinney Removed all @category, @package, and @subpackage annotations
- Per zendframework/zf2#2743, and following on zendframework/zf2#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.
8608e19
@weierophinney weierophinney referenced this issue from a commit in zendframework/zend-captcha
@weierophinney weierophinney Removed all @category, @package, and @subpackage annotations
- Per zendframework/zf2#2743, and following on zendframework/zf2#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.
befa345
@weierophinney weierophinney referenced this issue from a commit in zendframework/zend-uri
@weierophinney weierophinney Removed all @category, @package, and @subpackage annotations
- Per zendframework/zf2#2743, and following on zendframework/zf2#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.
aab3135
@weierophinney weierophinney referenced this issue from a commit in zendframework/zend-eventmanager
@weierophinney weierophinney Removed all @category, @package, and @subpackage annotations
- Per zendframework/zf2#2743, and following on zendframework/zf2#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.
3db9a73
@weierophinney weierophinney referenced this issue from a commit in zendframework/zend-servicemanager
@weierophinney weierophinney Removed all @category, @package, and @subpackage annotations
- Per zendframework/zf2#2743, and following on zendframework/zf2#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.
a310744
@weierophinney weierophinney referenced this issue from a commit in zendframework/zend-tag
@weierophinney weierophinney Removed all @category, @package, and @subpackage annotations
- Per zendframework/zf2#2743, and following on zendframework/zf2#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.
5a2cad5
@weierophinney weierophinney referenced this issue from a commit in zendframework/zend-debug
@weierophinney weierophinney Removed all @category, @package, and @subpackage annotations
- Per zendframework/zf2#2743, and following on zendframework/zf2#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.
35911a8
@weierophinney weierophinney referenced this issue from a commit in zendframework/zend-math
@weierophinney weierophinney Removed all @category, @package, and @subpackage annotations
- Per zendframework/zf2#2743, and following on zendframework/zf2#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.
298d1ab
@weierophinney weierophinney referenced this issue from a commit in zendframework/zend-loader
@weierophinney weierophinney Removed all @category, @package, and @subpackage annotations
- Per zendframework/zf2#2743, and following on zendframework/zf2#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.
42eacae
@weierophinney weierophinney referenced this issue from a commit in zendframework/zend-memory
@weierophinney weierophinney Removed all @category, @package, and @subpackage annotations
- Per zendframework/zf2#2743, and following on zendframework/zf2#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.
b0c8c32
@weierophinney weierophinney referenced this issue from a commit in zendframework/zend-modulemanager
@weierophinney weierophinney Removed all @category, @package, and @subpackage annotations
- Per zendframework/zf2#2743, and following on zendframework/zf2#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.
3fddbec
@weierophinney weierophinney referenced this issue from a commit in zendframework/zend-config
@weierophinney weierophinney Removed all @category, @package, and @subpackage annotations
- Per zendframework/zf2#2743, and following on zendframework/zf2#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.
14dce2d
@weierophinney weierophinney referenced this issue from a commit in zendframework/zend-test
@weierophinney weierophinney Removed all @category, @package, and @subpackage annotations
- Per zendframework/zf2#2743, and following on zendframework/zf2#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.
f157fc7
@weierophinney weierophinney referenced this issue from a commit in zendframework/zend-stdlib
@weierophinney weierophinney Removed all @category, @package, and @subpackage annotations
- Per zendframework/zf2#2743, and following on zendframework/zf2#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.
2fb372e
@weierophinney weierophinney referenced this issue from a commit in zendframework/zend-crypt
@weierophinney weierophinney Removed all @category, @package, and @subpackage annotations
- Per zendframework/zf2#2743, and following on zendframework/zf2#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.
0dfb158
@weierophinney weierophinney referenced this issue from a commit in zendframework/zend-paginator
@weierophinney weierophinney Removed all @category, @package, and @subpackage annotations
- Per zendframework/zf2#2743, and following on zendframework/zf2#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.
63542d5
@weierophinney weierophinney referenced this issue from a commit in zendframework/zend-serializer
@weierophinney weierophinney Removed all @category, @package, and @subpackage annotations
- Per zendframework/zf2#2743, and following on zendframework/zf2#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.
20f58f7
@weierophinney weierophinney referenced this issue from a commit in zendframework/zend-i18n
@weierophinney weierophinney Removed all @category, @package, and @subpackage annotations
- Per zendframework/zf2#2743, and following on zendframework/zf2#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.
91e54d4
@weierophinney weierophinney referenced this issue from a commit in zendframework/zend-text
@weierophinney weierophinney Removed all @category, @package, and @subpackage annotations
- Per zendframework/zf2#2743, and following on zendframework/zf2#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.
047d563
@weierophinney weierophinney referenced this issue from a commit in zendframework/zend-xmlrpc
@weierophinney weierophinney Removed all @category, @package, and @subpackage annotations
- Per zendframework/zf2#2743, and following on zendframework/zf2#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.
905f559
@weierophinney weierophinney referenced this issue from a commit in zendframework/zend-inputfilter
@weierophinney weierophinney Removed all @category, @package, and @subpackage annotations
- Per zendframework/zf2#2743, and following on zendframework/zf2#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.
2f0b6e4
@weierophinney weierophinney referenced this issue from a commit in zendframework/zend-di
@weierophinney weierophinney Removed all @category, @package, and @subpackage annotations
- Per zendframework/zf2#2743, and following on zendframework/zf2#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.
8d0f5cb
@weierophinney weierophinney referenced this issue from a commit in zendframework/zend-http
@weierophinney weierophinney Removed all @category, @package, and @subpackage annotations
- Per zendframework/zf2#2743, and following on zendframework/zf2#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.
fff8c71
@weierophinney weierophinney referenced this issue from a commit in zendframework/zend-server
@weierophinney weierophinney Removed all @category, @package, and @subpackage annotations
- Per zendframework/zf2#2743, and following on zendframework/zf2#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.
d1315fd
@weierophinney weierophinney referenced this issue from a commit in zendframework/zend-progressbar
@weierophinney weierophinney Removed all @category, @package, and @subpackage annotations
- Per zendframework/zf2#2743, and following on zendframework/zf2#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.
a66cad1
@weierophinney weierophinney referenced this issue from a commit in zendframework/zend-console
@weierophinney weierophinney Removed all @category, @package, and @subpackage annotations
- Per zendframework/zf2#2743, and following on zendframework/zf2#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.
6bda8b3
@weierophinney weierophinney referenced this issue from a commit in zendframework/zend-filter
@weierophinney weierophinney Removed all @category, @package, and @subpackage annotations
- Per zendframework/zf2#2743, and following on zendframework/zf2#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.
a08e003
@weierophinney weierophinney referenced this issue from a commit in zendframework/zend-ldap
@weierophinney weierophinney Removed all @category, @package, and @subpackage annotations
- Per zendframework/zf2#2743, and following on zendframework/zf2#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.
1f00766
@weierophinney weierophinney referenced this issue from a commit in zendframework/zend-json
@weierophinney weierophinney Removed all @category, @package, and @subpackage annotations
- Per zendframework/zf2#2743, and following on zendframework/zf2#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.
263fac7
@weierophinney weierophinney referenced this issue from a commit in zendframework/zend-validator
@weierophinney weierophinney Removed all @category, @package, and @subpackage annotations
- Per zendframework/zf2#2743, and following on zendframework/zf2#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.
9fa7652
@weierophinney weierophinney referenced this issue from a commit in zendframework/zend-file
@weierophinney weierophinney Removed all @category, @package, and @subpackage annotations
- Per zendframework/zf2#2743, and following on zendframework/zf2#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.
9708f47
@weierophinney weierophinney referenced this issue from a commit in zendframework/zend-escaper
@weierophinney weierophinney Removed all @category, @package, and @subpackage annotations
- Per zendframework/zf2#2743, and following on zendframework/zf2#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.
4f260e0
@weierophinney weierophinney referenced this issue from a commit in zendframework/zend-dom
@weierophinney weierophinney Removed all @category, @package, and @subpackage annotations
- Per zendframework/zf2#2743, and following on zendframework/zf2#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.
684900b
@weierophinney weierophinney referenced this issue from a commit in zendframework/zend-session
@weierophinney weierophinney Removed all @category, @package, and @subpackage annotations
- Per zendframework/zf2#2743, and following on zendframework/zf2#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.
b32c347
@weierophinney weierophinney referenced this issue from a commit in zendframework/zend-log
@weierophinney weierophinney Removed all @category, @package, and @subpackage annotations
- Per zendframework/zf2#2743, and following on zendframework/zf2#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.
b39d4f0
@weierophinney weierophinney referenced this issue from a commit in zendframework/zend-cache
@weierophinney weierophinney Removed all @category, @package, and @subpackage annotations
- Per zendframework/zf2#2743, and following on zendframework/zf2#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.
574ef4f
@weierophinney weierophinney referenced this issue from a commit in zendframework/zend-soap
@weierophinney weierophinney Removed all @category, @package, and @subpackage annotations
- Per zendframework/zf2#2743, and following on zendframework/zf2#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.
72650c4
@weierophinney weierophinney referenced this issue from a commit in zendframework/zend-mime
@weierophinney weierophinney Removed all @category, @package, and @subpackage annotations
- Per zendframework/zf2#2743, and following on zendframework/zf2#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.
a90b147
@weierophinney weierophinney referenced this issue from a commit in zendframework/zend-view
@weierophinney weierophinney Removed all @category, @package, and @subpackage annotations
- Per zendframework/zf2#2743, and following on zendframework/zf2#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.
7725142
@weierophinney weierophinney referenced this issue from a commit in zendframework/zend-navigation
@weierophinney weierophinney Removed all @category, @package, and @subpackage annotations
- Per zendframework/zf2#2743, and following on zendframework/zf2#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.
7f59d40
@weierophinney weierophinney referenced this issue from a commit in zendframework/zend-feed
@weierophinney weierophinney Removed all @category, @package, and @subpackage annotations
- Per zendframework/zf2#2743, and following on zendframework/zf2#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.
2d5155e
@weierophinney weierophinney referenced this issue from a commit in zendframework/zend-permissions-acl
@weierophinney weierophinney Removed all @category, @package, and @subpackage annotations
- Per zendframework/zf2#2743, and following on zendframework/zf2#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.
307698f
@weierophinney weierophinney referenced this issue from a commit in zendframework/zend-permissions-rbac
@weierophinney weierophinney Removed all @category, @package, and @subpackage annotations
- Per zendframework/zf2#2743, and following on zendframework/zf2#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.
a5d3279
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Something went wrong with that request. Please try again.