Zend Framework

DocBlock Standardization

Details

  • Type: Coding Standards Violation Coding Standards Violation
  • Status: Resolved Resolved
  • Priority: Minor Minor
  • Resolution: Fixed
  • Affects Version/s: 0.2.0
  • Fix Version/s: 1.6.0
  • Component/s: None
  • Labels:
    None

Description

The coding standards should provide accurate docblocks that can be cut and pasted into code by framework developers:

http://framework.zend.com/wiki/x/PQ

The current examples do not reflect de facto standards in the framework code base.

Issue Links

This issue depends on:
ZF-691 Coding Standards Version 1.0 Major Open
This issue is dependecy of:
ZF-3065 Create CodeSniffer ruleset to accompany coding standards Major Open

Activity

Ascending order - Click to sort in descending order
Hide
Permalink
Ralph Schindler added a comment -

Linked to doc standards cleanup

Show
Ralph Schindler added a comment - Linked to doc standards cleanup
Hide
Permalink
Simone Carletti added a comment -

+1 for this ticket.

I'm feeling a bit confused.
Here you suggest to use a block with a license that is no longer the right one (see ZF-507).

Here ZF-703 Bill agree to include SVN $Id$ keyword in files but I can't find many files using it in the latest ZF release.

Many files have different copyright string with basically the same information

Copyright (c) 2005-2007 Zend Technologies USA Inc. (http://www.zend.com)
Copyright (c) 2005-2008 Zend Technologies USA Inc. (http://www.zend.com)
Copyright (c) 2005-2007 Zend Technologies USA Inc. (http://www.zend.com/)
Copyright (c) 2007 Jordan Raub <ludicruz@yahoo.com> and Felix Jendrusch <felixjendrusch@googlemail.com>

A definitive standard would be more than welcome.

Show
Simone Carletti added a comment - +1 for this ticket. I'm feeling a bit confused. Here you suggest to use a block with a license that is no longer the right one (see ZF-507). Here ZF-703 Bill agree to include SVN $Id$ keyword in files but I can't find many files using it in the latest ZF release. Many files have different copyright string with basically the same information
Copyright (c) 2005-2007 Zend Technologies USA Inc. (http://www.zend.com) Copyright (c) 2005-2008 Zend Technologies USA Inc. (http://www.zend.com) Copyright (c) 2005-2007 Zend Technologies USA Inc. (http://www.zend.com/) Copyright (c) 2007 Jordan Raub <ludicruz@yahoo.com> and Felix Jendrusch <felixjendrusch@googlemail.com>
A definitive standard would be more than welcome.
Hide
Permalink
Wil Sinclair added a comment -

This issue should have been fixed for the 1.5 release.

Show
Wil Sinclair added a comment - This issue should have been fixed for the 1.5 release.
Hide
Permalink
Wil Sinclair added a comment -

This doesn't appear to have been fixed in 1.5.0. Please update if this is not correct.

Show
Wil Sinclair added a comment - This doesn't appear to have been fixed in 1.5.0. Please update if this is not correct.
Hide
Permalink
Wil Sinclair added a comment -

Thomas, aren't you working on this now? If so, please close this when you are finished. Otherwise, feel free to unassign it from yourself.

Show
Wil Sinclair added a comment - Thomas, aren't you working on this now? If so, please close this when you are finished. Otherwise, feel free to unassign it from yourself.
Hide
Permalink
Thomas Weidner added a comment -

I'm working on the coding standard testbed which will then also close this issue.

Actually I've already fixed this issue for the existing files, but as new files are added we will for now have the problem also for them. See r9245 where darby added the header for a new file afterwards.

I will keep this issue opened until I have finished the testbed.
Ralph and me are working on closing the whole bunch of issues related to this.

Show
Thomas Weidner added a comment - I'm working on the coding standard testbed which will then also close this issue. Actually I've already fixed this issue for the existing files, but as new files are added we will for now have the problem also for them. See r9245 where darby added the header for a new file afterwards. I will keep this issue opened until I have finished the testbed. Ralph and me are working on closing the whole bunch of issues related to this.
Hide
Permalink
Wil Sinclair added a comment -

Updating to comply with new IT component conventions.

Show
Wil Sinclair added a comment - Updating to comply with new IT component conventions.
Hide
Permalink
Thomas Weidner added a comment -

The Docblock is checked and forced by the new CodeSniffer ruleset.
Actually all files within the core have the new docblock integrated.

Show
Thomas Weidner added a comment - The Docblock is checked and forced by the new CodeSniffer ruleset. Actually all files within the core have the new docblock integrated.
Hide
Permalink
Wil Sinclair added a comment -

Updating for the 1.6.0 release.

Show
Wil Sinclair added a comment - Updating for the 1.6.0 release.

People

Vote (1)
Watch (1)

Dates

  • Created:
    Updated:
    Resolved:

Time Tracking

Estimated:
1d
Original Estimate - 1 day
Remaining:
1d
Remaining Estimate - 1 day
Logged:
Not Specified
Time Spent - Not Specified
Atlassian JIRA (v4.4.3#663-r165197) | Report a problem
Powered by a free Atlassian JIRA open source license for Zend Framework. Try JIRA - bug tracking software for your team.