cvs: phpdoc /en/reference/rar .cvsignore ini.xml reference.xml /en/reference/rar/functions Rar-extract.xml Rar-getAttr.xml Rar-getCrc.xml Rar-getFileTime.xml Rar-getHostOs.xml Rar-getMethod.xml Rar-getName.xml Rar-getPackedSize.xml Rar-getUnpackedSize.xml Rar-getVersion.xml rar-close.xml rar-entry-get.xml rar-list.xml rar-open.xml

[Antony Dovgal]

tony2001 Wed Sep 22 11:51:30 2004 EDT

Added files:
/phpdoc/en/reference/rar .cvsignore ini.xml reference.xml
/phpdoc/en/reference/rar/functions Rar-extract.xml Rar-getAttr.xml
Rar-getCrc.xml
Rar-getFileTime.xml
Rar-getHostOs.xml
Rar-getMethod.xml
Rar-getName.xml
Rar-getPackedSize.xml
Rar-getUnpackedSize.xml
Rar-getVersion.xml rar-close.xml
rar-entry-get.xml rar-list.xml
rar-open.xml
Log:
add Rar reference

#please, check my English, I'm not a native speaker
#thanks

[Sean Coates]

I don't see it (in a glance) in the dochowto, but isn't it normal for
filenames to be all lowercase?

S

Post by Antony Dovgal
tony2001 Wed Sep 22 11:51:30 2004 EDT
/phpdoc/en/reference/rar .cvsignore ini.xml reference.xml
/phpdoc/en/reference/rar/functions Rar-extract.xml Rar-getAttr.xml
Rar-getCrc.xml
Rar-getFileTime.xml
Rar-getHostOs.xml
Rar-getMethod.xml
Rar-getName.xml
Rar-getPackedSize.xml
Rar-getUnpackedSize.xml
Rar-getVersion.xml rar-close.xml
rar-entry-get.xml rar-list.xml
rar-open.xml
add Rar reference

[Antony Dovgal]

On Wed, 22 Sep 2004 12:10:51 -0400

Post by Sean Coates
I don't see it (in a glance) in the dochowto, but isn't it normal for
filenames to be all lowercase?

reasonable question.
btw, en/reference/memcache isn't in lowercase too.

[Philip Olson]

Post by Antony Dovgal

Post by Sean Coates
I don't see it (in a glance) in the dochowto, but isn't it normal for
filenames to be all lowercase?

reasonable question.
btw, en/reference/memcache isn't in lowercase too.

All files should be lowercased, and all new docs should follow the
new doc style.

Regards,
Philip

[Friedhelm Betz]

Philip Olson wrote:
[...}

Post by Philip Olson
All files should be lowercased, and all new docs should follow the
new doc style.

Is the new doc style "official"? Or still be to considered as rfc?
The dochowto says: Do not implement this style yet!
<cite>
And we're introducing a new doc skeleton where multiple refsect1's are
used, as well as a lot more entities. Names in ALLCAPS would be changed
so for example RETURNTYPE would instead be bool, string, etc. Here's a
draft using example_func() as an example. Do not implement this style
yet! There are also reftitles for classes, constructors, and methods. An
OOP doc skeleton will be written in the future. reftitles are located in
language-defs.ent.
</cite>

curious ;-)

Friedhelm

[Philip Olson]

Post by Friedhelm Betz

Post by Philip Olson
All files should be lowercased, and all new docs should follow the
new doc style.

Is the new doc style "official"? Or still be to considered as rfc?
The dochowto says: Do not implement this style yet!
<cite>
And we're introducing a new doc skeleton where multiple refsect1's are
used, as well as a lot more entities. Names in ALLCAPS would be changed
so for example RETURNTYPE would instead be bool, string, etc. Here's a
draft using example_func() as an example. Do not implement this style
yet! There are also reftitles for classes, constructors, and methods. An
OOP doc skeleton will be written in the future. reftitles are located in
language-defs.ent.
</cite>
curious ;-)

Don't read the HOWTO, it's outdated :) The new style is almost done
with basically only one remaining item...have a look here:

http://wiki.phpdoc.info/DocSkel

Just today I asked Goba to look into the constants issue, I gave up
on doing it [well].

Regards,
Philip

[Friedhelm Betz]

Post by Philip Olson

Post by Friedhelm Betz

Post by Philip Olson
All files should be lowercased, and all new docs should follow the
new doc style.

Is the new doc style "official"? Or still be to considered as rfc?
The dochowto says: Do not implement this style yet!
<cite>
And we're introducing a new doc skeleton where multiple refsect1's are
used, as well as a lot more entities. Names in ALLCAPS would be changed
so for example RETURNTYPE would instead be bool, string, etc. Here's a
draft using example_func() as an example. Do not implement this style
yet! There are also reftitles for classes, constructors, and methods. An
OOP doc skeleton will be written in the future. reftitles are located in
language-defs.ent.
</cite>
curious ;-)

Don't read the HOWTO, it's outdated :) The new style is almost done
http://wiki.phpdoc.info/DocSkel
Just today I asked Goba to look into the constants issue, I gave up
on doing it [well].

One may not consider http://wiki.phpdoc.info/DocSkel as a place to look
how to write documentation.
As you said, the new style is not yet finished (because the constants
issue) how can we force people to follow the new doc style?
So the question remains: is it common agreement, is it finished, or will
there be significant changes?

I thought the dochowto is the place where the relevant infos should be
in? ;-)

No, I am not against the new doc style, but your info provided above can
not be found easily and http://wiki.phpdoc.info/ is just a nice
playground, no?

Do not get me wrong, I don't mind if people set up things like
http://wiki.phpdoc.info/ (it is really nice, I know that site) but we
can not expect people to know http://wiki.phpdoc.info/ as a place to
look how to document things.

Friedhelm

[Philip Olson]

Post by Friedhelm Betz

Post by Philip Olson

Post by Friedhelm Betz

Post by Philip Olson
All files should be lowercased, and all new docs should follow the
new doc style.

Is the new doc style "official"? Or still be to considered as rfc?
The dochowto says: Do not implement this style yet!
<cite>
And we're introducing a new doc skeleton where multiple refsect1's are
used, as well as a lot more entities. Names in ALLCAPS would be changed
so for example RETURNTYPE would instead be bool, string, etc. Here's a
draft using example_func() as an example. Do not implement this style
yet! There are also reftitles for classes, constructors, and methods. An
OOP doc skeleton will be written in the future. reftitles are located in
language-defs.ent.
</cite>
curious ;-)

Don't read the HOWTO, it's outdated :) The new style is almost done
http://wiki.phpdoc.info/DocSkel
Just today I asked Goba to look into the constants issue, I gave up
on doing it [well].

One may not consider http://wiki.phpdoc.info/DocSkel as a place to look
how to write documentation.
As you said, the new style is not yet finished (because the constants
issue) how can we force people to follow the new doc style?
So the question remains: is it common agreement, is it finished, or will
there be significant changes?
I thought the dochowto is the place where the relevant infos should be
in? ;-)
No, I am not against the new doc style, but your info provided above can
not be found easily and http://wiki.phpdoc.info/ is just a nice
playground, no?
Do not get me wrong, I don't mind if people set up things like
http://wiki.phpdoc.info/ (it is really nice, I know that site) but we
can not expect people to know http://wiki.phpdoc.info/ as a place to
look how to document things.

It will go in the HOWTO when finished. Several new documentated
extensions follow the new style, and countless emails have gone
through this list on the topic. The issue of constants is a
small part of the new style and certainly not a holdup in terms
of using it versus the old style. It's a difference of rewriting
the entire extensions documentation, or, a few constant changes.

Regards,
Philip

[Antony Dovgal]

On Wed, 22 Sep 2004 16:54:33 +0000 (GMT)

Post by Philip Olson

Post by Antony Dovgal

Post by Sean Coates
I don't see it (in a glance) in the dochowto, but isn't it normal
for filenames to be all lowercase?

reasonable question.
btw, en/reference/memcache isn't in lowercase too.

All files should be lowercased, and all new docs should follow the
new doc style.

Ok, I'll change it later a bit.
Currently I'm at the conference =)