Undocumented classes/methods

Hi all,
We are using this tool for our framework, we've missed a
feature that
list all the undocumented methods and classes in our
project. We think
its useful specially when all the hard work its done, and
you need to
fine-tune the documentation (in a new release for example).

This morning, after looking the code I figure out how to do
this kind
of listing in a simple way. The idea is to throw a new
warning  in the
methods handleMethod/handleClass in the class
phpDocumentor_IntermediateParser when the element hasn't got
a
docblock, so you can see the undocumented elements in the
error page.

What do you think? I can provide a patch for this feature if
you like.

Sorry for my poor english (I'm trying to improve it) and
thanks to all
the developers,
Sebastián Marconi

------------------------------------------------------------
-------------
Take Surveys. Earn Cash. Influence the Future of IT
Join SourceForge.net's Techsay panel and you'll get the
chance to share your
opinions on IT & business topics through brief surveys -
and earn cash
http://www.techsay.com/default.
php?page=join.php&p=sourceforge&CID=DEVDEV
_______________________________________________
Phpdocu-developer mailing list
Phpdocu-developerlists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/phpdo
cu-developer

I'm not really sure you'd want undocumented methods showing
up on the 
warnings page but the overall idea is good.

But i'd start with a patch that does that, post it on the
patch manager 
in sf once you've got it working and will see where we can
go from there.
-josh
Sebastián Marconi wrote:
> Hi all,
> We are using this tool for our framework, we've missed
a feature that
> list all the undocumented methods and classes in our
project. We think
> its useful specially when all the hard work its done,
and you need to
> fine-tune the documentation (in a new release for
example).
>
> This morning, after looking the code I figure out how
to do this kind
> of listing in a simple way. The idea is to throw a new
warning  in the
> methods handleMethod/handleClass in the class
> phpDocumentor_IntermediateParser when the element
hasn't got a
> docblock, so you can see the undocumented elements in
the error page.
>
> What do you think? I can provide a patch for this
feature if you like.
>
> Sorry for my poor english (I'm trying to improve it)
and thanks to all
> the developers,
> Sebastián Marconi
>
>
------------------------------------------------------------
-------------
> Take Surveys. Earn Cash. Influence the Future of IT
> Join SourceForge.net's Techsay panel and you'll get the
chance to share your
> opinions on IT & business topics through brief
surveys - and earn cash
> http://www.techsay.com/default.
php?page=join.php&p=sourceforge&CID=DEVDEV
> _______________________________________________
> Phpdocu-developer mailing list
> Phpdocu-developerlists.sourceforge.net
> https://lists.sourceforge.net/lists/listinfo/phpdo
cu-developer
>   


------------------------------------------------------------
-------------
Take Surveys. Earn Cash. Influence the Future of IT
Join SourceForge.net's Techsay panel and you'll get the
chance to share your
opinions on IT & business topics through brief surveys -
and earn cash
http://www.techsay.com/default.
php?page=join.php&p=sourceforge&CID=DEVDEV
_______________________________________________
Phpdocu-developer mailing list
Phpdocu-developerlists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/phpdo
cu-developer

I'm not really sure you'd want undocumented methods showing
up on the 
warnings page but the overall idea is good.

But i'd start with a patch that does that, post it on the
patch manager 
in sf once you've got it working and will see where we can
go from there.
-josh
Sebastián Marconi wrote:
> Hi all,
> We are using this tool for our framework, we've missed
a feature that
> list all the undocumented methods and classes in our
project. We think
> its useful specially when all the hard work its done,
and you need to
> fine-tune the documentation (in a new release for
example).
>
> This morning, after looking the code I figure out how
to do this kind
> of listing in a simple way. The idea is to throw a new
warning  in the
> methods handleMethod/handleClass in the class
> phpDocumentor_IntermediateParser when the element
hasn't got a
> docblock, so you can see the undocumented elements in
the error page.
>
> What do you think? I can provide a patch for this
feature if you like.
>
> Sorry for my poor english (I'm trying to improve it)
and thanks to all
> the developers,
> Sebastián Marconi
>
>
------------------------------------------------------------
-------------
> Take Surveys. Earn Cash. Influence the Future of IT
> Join SourceForge.net's Techsay panel and you'll get the
chance to share your
> opinions on IT & business topics through brief
surveys - and earn cash
> http://www.techsay.com/default.
php?page=join.php&p=sourceforge&CID=DEVDEV
> _______________________________________________
> Phpdocu-developer mailing list
> Phpdocu-developerlists.sourceforge.net
> https://lists.sourceforge.net/lists/listinfo/phpdo
cu-developer
>   


------------------------------------------------------------
-------------
Take Surveys. Earn Cash. Influence the Future of IT
Join SourceForge.net's Techsay panel and you'll get the
chance to share your
opinions on IT & business topics through brief surveys -
and earn cash
http://www.techsay.com/default.
php?page=join.php&p=sourceforge&CID=DEVDEV
_______________________________________________
Phpdocu-developer mailing list
Phpdocu-developerlists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/phpdo
cu-developer

OK, the patch that works for us it's here:
https://
sourceforge.net/tracker/index.php?func=detail&aid=162253
8&group_id=11194&atid=311194

I found an (old) related bug, #1044752
https://
sourceforge.net/tracker/index.php?func=detail&aid=104475
2&group_id=11194&atid=361194

Thanks,
Sebastián Marconi
On 12/26/06, Joshua Eichorn <joshbluga.net> wrote:
> I'm not really sure you'd want undocumented methods
showing up on the
> warnings page but the overall idea is good.
>
> But i'd start with a patch that does that, post it on
the patch manager
> in sf once you've got it working and will see where we
can go from there.
> -josh
> Sebastián Marconi wrote:
> > Hi all,
> > We are using this tool for our framework, we've
missed a feature that
> > list all the undocumented methods and classes in
our project. We think
> > its useful specially when all the hard work its
done, and you need to
> > fine-tune the documentation (in a new release for
example).
> >
> > This morning, after looking the code I figure out
how to do this kind
> > of listing in a simple way. The idea is to throw a
new warning  in the
> > methods handleMethod/handleClass in the class
> > phpDocumentor_IntermediateParser when the element
hasn't got a
> > docblock, so you can see the undocumented elements
in the error page.
> >
> > What do you think? I can provide a patch for this
feature if you like.
> >
> > Sorry for my poor english (I'm trying to improve
it) and thanks to all
> > the developers,
> > Sebastián Marconi
> >
> >
------------------------------------------------------------
-------------
> > Take Surveys. Earn Cash. Influence the Future of
IT
> > Join SourceForge.net's Techsay panel and you'll
get the chance to share your
> > opinions on IT & business topics through brief
surveys - and earn cash
> > http://www.techsay.com/default.
php?page=join.php&p=sourceforge&CID=DEVDEV
> > _______________________________________________
> > Phpdocu-developer mailing list
> > Phpdocu-developerlists.sourceforge.net
> > https://lists.sourceforge.net/lists/listinfo/phpdo
cu-developer
> >
>
>

------------------------------------------------------------
-------------
Take Surveys. Earn Cash. Influence the Future of IT
Join SourceForge.net's Techsay panel and you'll get the
chance to share your
opinions on IT & business topics through brief surveys -
and earn cash
http://www.techsay.com/default.
php?page=join.php&p=sourceforge&CID=DEVDEV
_______________________________________________
Phpdocu-developer mailing list
Phpdocu-developerlists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/phpdo
cu-developer

OK, the patch that works for us it's here:
https://
sourceforge.net/tracker/index.php?func=detail&aid=162253
8&group_id=11194&atid=311194

I found an (old) related bug, #1044752
https://
sourceforge.net/tracker/index.php?func=detail&aid=104475
2&group_id=11194&atid=361194

Thanks,
Sebastián Marconi
On 12/26/06, Joshua Eichorn <joshbluga.net> wrote:
> I'm not really sure you'd want undocumented methods
showing up on the
> warnings page but the overall idea is good.
>
> But i'd start with a patch that does that, post it on
the patch manager
> in sf once you've got it working and will see where we
can go from there.
> -josh
> Sebastián Marconi wrote:
> > Hi all,
> > We are using this tool for our framework, we've
missed a feature that
> > list all the undocumented methods and classes in
our project. We think
> > its useful specially when all the hard work its
done, and you need to
> > fine-tune the documentation (in a new release for
example).
> >
> > This morning, after looking the code I figure out
how to do this kind
> > of listing in a simple way. The idea is to throw a
new warning  in the
> > methods handleMethod/handleClass in the class
> > phpDocumentor_IntermediateParser when the element
hasn't got a
> > docblock, so you can see the undocumented elements
in the error page.
> >
> > What do you think? I can provide a patch for this
feature if you like.
> >
> > Sorry for my poor english (I'm trying to improve
it) and thanks to all
> > the developers,
> > Sebastián Marconi
> >
> >
------------------------------------------------------------
-------------
> > Take Surveys. Earn Cash. Influence the Future of
IT
> > Join SourceForge.net's Techsay panel and you'll
get the chance to share your
> > opinions on IT & business topics through brief
surveys - and earn cash
> > http://www.techsay.com/default.
php?page=join.php&p=sourceforge&CID=DEVDEV
> > _______________________________________________
> > Phpdocu-developer mailing list
> > Phpdocu-developerlists.sourceforge.net
> > https://lists.sourceforge.net/lists/listinfo/phpdo
cu-developer
> >
>
>

------------------------------------------------------------
-------------
Take Surveys. Earn Cash. Influence the Future of IT
Join SourceForge.net's Techsay panel and you'll get the
chance to share your
opinions on IT & business topics through brief surveys -
and earn cash
http://www.techsay.com/default.
php?page=join.php&p=sourceforge&CID=DEVDEV
_______________________________________________
Phpdocu-developer mailing list
Phpdocu-developerlists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/phpdo
cu-developer