/ 
SHARYANTO-Utils-0.57
River stage zero No dependents
/ SHARYANTO::Role::Doc::Section::AddTextLines

NAME

SHARYANTO::Role::Doc::Section::AddTextLines - Provide add_doc_lines() to add text with optional text wrapping

VERSION

version 0.57

DESCRIPTION

This role provides add_doc_lines() which can add optionally wrapped text to doc_lines.

The default column width for wrapping is from COLUMNS environment variable, or 80.

ATTRIBUTES

doc_wrap => BOOL (default: 1)

Whether to do text wrapping.

REQUIRES

These methods are provided by, e.g. SHARYANTO::Role::Doc::Section.

$o->doc_lines()

$o->doc_indent_level()

$o->doc_lines_str()

METHODS

$o->add_doc_lines([\%opts, ]@lines)

Add lines of text, optionally wrapping each line if wrapping is enabled.

Available options:

  • wrap => BOOL

    Whether to enable wrapping. Default is from the doc_wrap attribute.

ENVIRONMENT

COLUMNS => INT

Used to set column width.

SEE ALSO

SHARYANTO::Role::Doc::Section

AUTHOR

Steven Haryanto <stevenharyanto@gmail.com>

COPYRIGHT AND LICENSE

This software is copyright (c) 2013 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.

FUNCTIONS

None are exported by default, but they are exportable.