Philip Olson wrote:
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].

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

Reply via email to