Home > Archive > PHP PEAR Questions and Answers > July 2005 > Re: [PEAR-QA] Re: 1 file / 1 class == 2 headers
You are viewing an archived Text-only version of the thread.
To view this thread in it's original format and/or if you want to reply to
this thread please [click here]
| Author |
Re: [PEAR-QA] Re: 1 file / 1 class == 2 headers
|
|
| bertrand Gugger 2005-07-31, 5:16 pm |
| Hey Paul,
Paul Jones wrote:
> Hi Bertrand -- I don't mean to be dumb, but I don't understand what
> you're getting at here.
I made the 50+ CS headers so I could bundle in tikiwiki.
(for license and ...
copyright ...
(quite absent, a LGPL without copyright has no meaning)
I don't have any critic against the many classes.
My question relates to 1 file / 1 class an 2 headers.
We (tikiwiki) succeed (or will) to pass in there ... that's not easy.
à+
--
bertrand "toggg" Gugger
>
>
> On Jul 31, 2005, at 8:53 AM, bertrand Gugger wrote:
>
>
>
>
>
>
> --
>
> Paul M. Jones <http://paul-m-jones.com>
>
> Solar: Simple Object Library and Application Repository
> for PHP5. <http://solarphp.com>
>
> Savant: The simple, elegant, and powerful alternative to
> Smarty for templates in PHP. <http://phpsavant.com>
>
| |
| Paul Jones 2005-07-31, 5:16 pm |
|
On Jul 31, 2005, at 9:58 AM, bertrand Gugger wrote:
>
> I made the 50+ CS headers so I could bundle in tikiwiki.
> (for license and ...
> copyright ...
> (quite absent, a LGPL without copyright has no meaning)
Ah yes, you're right, I should add those. Thanks for pointing it out.
> I don't have any critic against the many classes.
>
> My question relates to 1 file / 1 class an 2 headers.
I take it you mean two DocBlock headers? I think that's the PEAR
standard; one for the file itself, and one for each class and
function in the file. I think phpDocumentor throws errors if you
don't have one for the file.
> We (tikiwiki) succeed (or will) to pass in there ... that's not easy.
I know. :-(
--
Paul M. Jones <http://paul-m-jones.com>
Solar: Simple Object Library and Application Repository
for PHP5. <http://solarphp.com>
Savant: The simple, elegant, and powerful alternative to
Smarty for templates in PHP. <http://phpsavant.com>
| |
| Greg Beaver 2005-07-31, 5:16 pm |
| Paul Jones wrote:
> I take it you mean two DocBlock headers? I think that's the PEAR
> standard; one for the file itself, and one for each class and function
> in the file. I think phpDocumentor throws errors if you don't have one
> for the file.
It's just a warning that phpDocumentor has made an assumption that the
file is the same as the package. This is always true for PEAR packages
and can be ignored. phpDocumentor is a kitchen sink, it is also
designed for documenting files where the developer has crammed in
several functions from one project, and classes from another.
phpDocumentor will make assumptions about which package constants,
global vars, functions, and include statements belong in unless it is
explicitly specified in a page-level docblock.
If you have 50 files to add the headers to, either don't add them, or
add one per day for 2 months :). Don't kill yourself over this one.
Greg
| |
| Paul Jones 2005-07-31, 5:16 pm |
|
On Jul 31, 2005, at 1:30 PM, Greg Beaver wrote:
>
> It's just a warning that phpDocumentor has made an assumption that
> the file is the same as the package. This is always true for PEAR
> packages and can be ignored. phpDocumentor is a kitchen sink, it
> is also designed for documenting files where the developer has
> crammed in several functions from one project, and classes from
> another. phpDocumentor will make assumptions about which package
> constants, global vars, functions, and include statements belong in
> unless it is explicitly specified in a page-level docblock.
Sorry about my misunderstanding. Thanks for the explanation; that
helps. :-)
-- pmj
| |
| bertrand Gugger 2005-07-31, 5:16 pm |
| Greg Beaver wrote:
> Paul Jones wrote:
>
>
>
> It's just a warning that phpDocumentor has made an assumption that the
> file is the same as the package.
no, it's a stuff accepted by vote, ask daniel
> This is always true for PEAR packages and can be ignored.
> phpDocumentor is a kitchen sink, it is also designed for documenting
> files where the developer has crammed in several functions from one
> project, and classes from another. phpDocumentor will make assumptions
> about which package constants, global vars, functions, and include
> statements belong in unless it is explicitly specified in a page-level
> docblock.
>
> If you have 50 files to add the headers to, either don't add them, or
> add one per day for 2 months :).
I can't , I have to backport,
try to understand what is a community
96 (?) headers are nothing but keep them synch ...
I did not made that structure ... sure not !
The plan (by tikiwiki) is to develop it , pack it , working
We don't do no theory
I don't :)
> Don't kill yourself over this one.
I will, that's all sily, whe can need more classes, I think it would be
better to keep it by pear, now, if we can't change what was accepted ...
Text_Wiki is possible, neat and flexible the same, no BC ... without 1
file / 1 class
OO ?
lol!
à+
--
bertrand "toggg" Gugger
|
|
|
|
|