- SEE ALSO
- COPYRIGHT AND LICENSE
SHARYANTO::Role::Doc::Section - Role for class that generates documentation with sections
SHARYANTO::Role::Doc::Section is a role for classes that produce documentation with sections. This role provides a workflow for parsing and generating sections, regulating indentation, and a
To generate documentation, first you provide a list of section names in
doc_sections. Then you run
generate_doc(), which will call
doc_gen_SECTION methods for each section consecutively.
doc_parse_* is supposed to parse information from some source into a form readily usable in $self->doc_parse hash.
doc_gen_* is supposed to generate the actual section in the final documentation format, by calling
add_doc_lines to add text. Finally all the added lines is concatenated together and returned.
This module uses Log::Any for logging.
This module uses Moo for object system.
Character(s) used for indent.
This module is used, among others, by:
Steven Haryanto <email@example.com>
This software is copyright (c) 2012 by Steven Haryanto.
This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.