Re: proto-skript [was authors....]
| From: | Maxim Maletsky | Date: | Mon, 03 Feb 2003 19:57:00 +0000 |
| Subject: | Re: proto-skript [was authors....] | ||
| References: | 1 2 | Groups: | php.doc |
| Request: | Send a blank email to phpdoc+get-969351516@lists.php.net to get a copy of this message | ||
I don't really want to parse the .c files for protos, that is already
being done by other scripts(*). What I want to try is to compare the
documentation data to the actual C code where possible to get some hints
what is not ideally matching. What has Ilia done and where is it?
--
Maxim Maletsky
maxim@php.net
Philip Olson <philip@cornado.com> wrote... :
> On Mon, 3 Feb 2003, Maxim Maletsky wrote:
> > Thanks, I think this can be useful to me.
> >
> > Actually, in base of this (and others out there) script(s), I am going
> > to attempt creating a script that parses both the C code and the docs
> > tree to look for any inconsistencies.
> >
> > Somewhat like a doc-bug hunter. The goal in this case will be to
> > analyze the current documentation and get listed the functions that do
> > not correspond to the current documentation, such as in our case some
> > return values and parameter counts. Would be helpful getting a
> > machine-generated summary of incorrectly documented protos and functions
> > (like for things that have been changed since they were documented etc).
> >
> > I already saw things doing similar to that, so I've got the base.
> >
> > Any thoughts/complains/suggestions? If what comes out will work well for
> > me and nobody objects, I will then commit it to the /phpdoc/scripts.
>
> Ilia has already created something that does this and
> he's been going through it doing minor tweaks here and
> there for awhile now. You may want to talk to him.
>
> Regards,
> Philip
>
>
>
>
>
> > Friedhelm Betz <holliwell@gmx.net> wrote... :
> >
> > > > > I have heard some rumors about someone creating a proto check script to
> > > > > check whether the protos in phpdoc reflect the current protos of
> > > > > functions in the php source. Take in account undocumented new
> > > > > parameters, etc. too... I don't think that anybody can get on this to
> > > > > do
> > > > > it manually in any reasonable time...
> > > >
> > > > Would be nice to investigate on this deeper and see whether we can do
> > > > something about it. I could go ahead to write a similar script myself.
> > >
> > > Take a look at /phpdoc/scripts/xml_proto.php
> > > never tried, but may be a good starting point.
> > >
> > > Friedhelm
> > >
> > >
> > > --
> > > PHP Documentation Mailing List (http://www.php.net/)
> > > To unsubscribe, visit: http://www.php.net/unsub.php
> > >
> >
> >
> > --
> > PHP Documentation Mailing List (http://www.php.net/)
> > To unsubscribe, visit: http://www.php.net/unsub.php
> >
>
>
> --
> PHP Documentation Mailing List (http://www.php.net/)
> To unsubscribe, visit: http://www.php.net/unsub.php
>