I would like to know how to make categorias in the 'methods'
In the POD I could use
=head1 Constructor
=head2 new
the constructor is here
=cut
=head1 Utility Methods
=head2 right
..
=cut
=head2 left
...
=cut
=head1 Private Methods
=head2 _panic
Don't even think about using it
= cut
In the HTML you obatin a classification of your methods in 3 Class : Constructor, Utility Methods and Private Methods
I would like to dothe same classification in ''toolbar' and 'table of methods' in Pdoc.
I have looked about the pdoc-1.0::Pdoc::Html::Renderers::Perlmodule render subroutine
I think that's the processs of iterate all the parserS on the current line causes to lost the classification included in the POD
Have you an idea about how to tackle this problem.
Thanks
Marc
If you would like to refer to this comment somewhere else in this project, copy and paste the following link:
terribly sorry for my very late answer and thank you for you comment.
Dividing the methods in categories separated by a =head1 tag is common in Perl POD and the Pdoc lib doesn't handle it properly yet. I also thought in implementing such feature and there is something on its way in the development code.
As you mentionned, this is the job of the PerlModule renderer. Since the document object contains the various =head tags in an ordered manner, it should be relatively easy to cope with such representation in the Methods table and in the methods description/code parts of the HTML file.
I must admit that the development of Pdoc has been on standby for a while but things should move again now.
Best regards,
Raphael
If you would like to refer to this comment somewhere else in this project, copy and paste the following link:
Hi
Pdoc is fantastic.
I would like to know how to make categorias in the 'methods'
In the POD I could use
=head1 Constructor
=head2 new
the constructor is here
=cut
=head1 Utility Methods
=head2 right
..
=cut
=head2 left
...
=cut
=head1 Private Methods
=head2 _panic
Don't even think about using it
= cut
In the HTML you obatin a classification of your methods in 3 Class : Constructor, Utility Methods and Private Methods
I would like to dothe same classification in ''toolbar' and 'table of methods' in Pdoc.
I have looked about the pdoc-1.0::Pdoc::Html::Renderers::Perlmodule render subroutine
I think that's the processs of iterate all the parserS on the current line causes to lost the classification included in the POD
Have you an idea about how to tackle this problem.
Thanks
Marc
Hi Marc,
terribly sorry for my very late answer and thank you for you comment.
Dividing the methods in categories separated by a =head1 tag is common in Perl POD and the Pdoc lib doesn't handle it properly yet. I also thought in implementing such feature and there is something on its way in the development code.
As you mentionned, this is the job of the PerlModule renderer. Since the document object contains the various =head tags in an ordered manner, it should be relatively easy to cope with such representation in the Methods table and in the methods description/code parts of the HTML file.
I must admit that the development of Pdoc has been on standby for a while but things should move again now.
Best regards,
Raphael