NAME

Liveman::Append - adds sections for methods and functions from lib/**.pm to lib/**.md

SYNOPSIS

use Liveman::Append;

my $liveman_append = Liveman::Append->new;

ref $liveman_append     # => Liveman::Append

DESCRIPTION

Adds a guide on the methods and functions of the modules (lib/**.pm) to their guidelines (lib/**.md).

1. Methods is a Perl subroutine starting with the sub keyword.

2. Features are instance properties added by OOP frameworks such as Aion, Mouse, Moose, Moo, Mo, and starting with the has keyword.

SUBROUTINES

new (@params)

Constructor.

mkmd ($md)

Creates an md-file.

appends ()

Adds to lib/**.md from lib/**.pm subprograms and features.

append ($path)

Adds subprograms and functions from the module ($path) to its manual.

File lib/Alt/The/Plan.pm:

package Alt::The::Plan;

sub planner {
	my ($self) = @_;
}

# This is first!
sub miting {
	my ($self, $meet, $man, $woman) = @_;
}

sub _exquise_me {
	my ($self, $meet, $man, $woman) = @_;
}

1;



-e "lib/Alt/The/Plan.md" # -> undef

# Set the mocks:
*Liveman::Append::_git_user_name = sub {'Yaroslav O. Kosmina'};
*Liveman::Append::_git_user_email = sub {'dart@cpan.org'};
*Liveman::Append::_year = sub {2023};
*Liveman::Append::_license = sub {"Perl5"};
*Liveman::Append::_land = sub {"Rusland"};

my $liveman_append = Liveman::Append->new->append("lib/Alt/The/Plan.pm");
$liveman_append->{count}	# -> 1
$liveman_append->{added}	# -> 2

-e "lib/Alt/The/Plan.md" # -> 1

# And again:
$liveman_append = Liveman::Append->new->append("lib/Alt/The/Plan.pm");
$liveman_append->{count}	# -> 1
$liveman_append->{added}	# -> 0

File lib/Alt/The/Plan.md is:

# NAME

Alt::The::Plan - 

# SYNOPSIS

\```perl
use Alt::The::Plan;

my $plan = Alt::The::Plan->new;
\```

# DESCRIPTION

.

# SUBROUTINES

## planner ()

.

\```perl
my $plan = Alt::The::Plan->new;
$plan->planner  # -> .3
\```

## miting ($meet, $man, $woman)

This is first!

\```perl
my $plan = Alt::The::Plan->new;
$plan->miting($meet, $man, $woman)  # -> .3
\```

# INSTALL

For install this module in your system run next [command](https://metacpan.org/pod/App::cpm):

\```sh
sudo cpm install -gvv Alt::The::Plan
\```

# AUTHOR

Yaroslav O. Kosmina <dart@cpan.org>

# LICENSE

⚖ **Perl5**

# COPYRIGHT

The Alt::The::Plan module is copyright © 2023 Yaroslav O. Kosmina. Rusland. All rights reserved.

AUTHOR

Yaroslav O. Kosmina mailto:dart@cpan.org

LICENSE

⚖ GPLv3

COPYRIGHT

The Liveman::Append module is Copyright © 2023 Yaroslav O. Kosmina. Rusland. All Rights Reserved.