sergiotarxz/Peace
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Finishing the documentation of already created modules.

Browse Source
This commit is contained in:
sergiotarxz 2022-03-18 07:27:55 +01:00
parent 1061a5168a
commit d90aa43644
9 changed files with 204 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

33
doc/lib/Peace/Controller/User.pm.html
View File

@ -2,7 +2,7 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml"> <html xmlns="http://www.w3.org/1999/xhtml">
<head> <head>
<title /> <title>Peace::Controller::User - Controller for user specific actions.</title>
<meta content="text/html; charset=utf-8" http-equiv="content-type" /> <meta content="text/html; charset=utf-8" http-equiv="content-type" />
<link href="mailto:Alpine@build-edge-aarch64.nonet" rev="made" /> <link href="mailto:Alpine@build-edge-aarch64.nonet" rev="made" />
</head> </head>
@ -11,6 +11,37 @@
<ul id="index">
<li><a href="#NAME">NAME</a></li>
<li><a href="#FUNCTIONS">FUNCTIONS</a>
<ul>
<li><a href="#post">post</a></li>
</ul>
</li>
<li><a href="#BUGS">BUGS</a></li>
<li><a href="#SEE-ALSO">SEE ALSO</a></li>
</ul>
<h1 id="NAME">NAME</h1>
<p>Peace::Controller::User - Controller for user specific actions.</p>
<h1 id="FUNCTIONS">FUNCTIONS</h1>
<p>Peace::Controller::User implements the following functions.</p>
<h2 id="post">post</h2>
<p>For internal usage</p>
<h1 id="BUGS">BUGS</h1>
<p>This file is no longer more than a template that&#39;s going to be deleted sooner or later when the http logic begins its development.</p>
<h1 id="SEE-ALSO">SEE ALSO</h1>
<p><a href="https://metacpan.org/pod/Mojolicious::Controller">Mojolicious::Controller</a></p>
</body> </body>

4
doc/lib/Peace/DAO/Application.pm.html
View File

@ -48,7 +48,7 @@ my $applications = $application_dao-&gt;recover_by_developer( developer =&gt; $d
<h1 id="DESCRIPTION">DESCRIPTION</h1> <h1 id="DESCRIPTION">DESCRIPTION</h1>
<p>Peace::DAO::Developer allows you to make database operations over the applications table like recover or create.</p> <p>Peace::DAO::Application allows you to make database operations over the applications table like recover or create.</p>
<h1 id="INSTANCE-METHODS">INSTANCE METHODS</h1> <h1 id="INSTANCE-METHODS">INSTANCE METHODS</h1>
@ -72,6 +72,8 @@ my $applications = $application_dao-&gt;recover_by_developer( developer =&gt; $d
<p>Takes a <a href="../Model/Application.pm.html">Peace::Model::Application</a> and creates its representation in database.</p> <p>Takes a <a href="../Model/Application.pm.html">Peace::Model::Application</a> and creates its representation in database.</p>
<p>As a side effect sets the fields uuid and date_creation in the passed object.</p>
<h2 id="recover_by_uuid">recover_by_uuid</h2> <h2 id="recover_by_uuid">recover_by_uuid</h2>
<pre><code>my $application = $application_dao-&gt;recover_by_uuid( <pre><code>my $application = $application_dao-&gt;recover_by_uuid(

74
doc/lib/Peace/DAO/Customer.pm.html
View File

@ -2,7 +2,7 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml"> <html xmlns="http://www.w3.org/1999/xhtml">
<head> <head>
<title /> <title>Peace::DAO::Customer - The database access object of customer.</title>
<meta content="text/html; charset=utf-8" http-equiv="content-type" /> <meta content="text/html; charset=utf-8" http-equiv="content-type" />
<link href="mailto:Alpine@build-edge-aarch64.nonet" rev="made" /> <link href="mailto:Alpine@build-edge-aarch64.nonet" rev="made" />
</head> </head>
@ -11,6 +11,78 @@
<ul id="index">
<li><a href="#NAME">NAME</a></li>
<li><a href="#SYNOPSIS">SYNOPSIS</a></li>
<li><a href="#DESCRIPTION">DESCRIPTION</a></li>
<li><a href="#INSTANCE-METHODS">INSTANCE METHODS</a>
<ul>
<li><a href="#new">new</a></li>
</ul>
</li>
<li><a href="#METHODS">METHODS</a>
<ul>
<li><a href="#create">create</a></li>
<li><a href="#recover_by_uuid">recover_by_uuid</a></li>
</ul>
</li>
<li><a href="#SEE-ALSO">SEE ALSO</a></li>
</ul>
<h1 id="NAME">NAME</h1>
<p>Peace::DAO::Customer - The database access object of customer.</p>
<h1 id="SYNOPSIS">SYNOPSIS</h1>
<pre><code>my $customer_dao = Peace::DAO::Customer-&gt;new(
dbh =&gt; $dbh,
);
$customer_dao-&gt;create( customer =&gt; $customer );
my $customer = $customer_dao-&gt;recover_by_uuid(
uuid =&gt; $uuid,
);</code></pre>
<h1 id="DESCRIPTION">DESCRIPTION</h1>
<p>Peace::DAO::Customer allows you to make database operations over the customers table like recover or create.</p>
<h1 id="INSTANCE-METHODS">INSTANCE METHODS</h1>
<p>Peace::DAO::Customer implements the following instance methods:</p>
<h2 id="new">new</h2>
<pre><code>my $customer_dao = Peace::DAO::Customer-&gt;new(
dbh =&gt; $dbh,
);</code></pre>
<p>Takes a database handle and instances a Peace::DAO::Customer object.</p>
<h1 id="METHODS">METHODS</h1>
<h2 id="create">create</h2>
<pre><code>$customer_dao-&gt;create(
customer =&gt; $customer,
);</code></pre>
<p>Takes a <a href="../Model/Customer.pm.html">Peace::Model::Customer</a> object and creates its database representation.</p>
<p>As a side effect sets the fields uuid and date_creation in the passed object.</p>
<h2 id="recover_by_uuid">recover_by_uuid</h2>
<pre><code>my $customer = $customer_dao-&gt;recover_by_uuid(
uuid =&gt; $uuid,
);</code></pre>
<h1 id="SEE-ALSO">SEE ALSO</h1>
<p><a href="../DB.pm.html">Peace::DB</a>, <a href="https://metacpan.org/pod/DBI">DBI</a>, <a href="../Model/Customer.pm.html">Peace::Model::Customer</a></p>
</body> </body>

2
doc/lib/Peace/DAO/Developer.pm.html
View File

@ -65,6 +65,8 @@ my $developer = $developer_dao-&gt;recover_by_uuid( uuid =&gt; $uuid );</code></
<p>Creates a representation in database of the passed developer object.</p> <p>Creates a representation in database of the passed developer object.</p>
<p>As a side effect sets the fields uuid and date_creation in the passed object.</p>
<h2 id="recover_by_uuid">recover_by_uuid</h2> <h2 id="recover_by_uuid">recover_by_uuid</h2>
<pre><code>my $developer = $developer_dao-&gt;recover_by_uuid( uuid =&gt; $uuid );</code></pre> <pre><code>my $developer = $developer_dao-&gt;recover_by_uuid( uuid =&gt; $uuid );</code></pre>

23
lib/Peace/Controller/User.pm
View File

@ -8,3 +8,26 @@ sub post {
$self->render( json => $user_data ); $self->render( json => $user_data );
} }
1; 1;
=encoding utf8
=head1 NAME
Peace::Controller::User - Controller for user specific actions.
=head1 FUNCTIONS
Peace::Controller::User implements the following functions.
=head2 post
For internal usage
=head1 BUGS
This file is no longer more than a template that's going
to be deleted sooner or later when the http logic begins
its development.
=head1 SEE ALSO
L<Mojolicious::Controller>

5
lib/Peace/DAO/Application.pm
View File

@ -168,7 +168,7 @@ Peace::DAO::Application - The database access object of applications.
=head1 DESCRIPTION =head1 DESCRIPTION
Peace::DAO::Developer allows you to make database Peace::DAO::Application allows you to make database
operations over the applications table like recover operations over the applications table like recover
or create. or create.
@ -195,6 +195,9 @@ Peace::DAO::Application implements the following methods:
Takes a L<Peace::Model::Application> and creates its Takes a L<Peace::Model::Application> and creates its
representation in database. representation in database.
As a side effect sets the fields uuid and date_creation
in the passed object.
=head2 recover_by_uuid =head2 recover_by_uuid
my $application = $application_dao->recover_by_uuid( my $application = $application_dao->recover_by_uuid(

60
lib/Peace/DAO/Customer.pm
View File

@ -88,3 +88,63 @@ sub _dbh {
return $self->{dbh}; return $self->{dbh};
} }
1; 1;
=encoding utf8
=head1 NAME
Peace::DAO::Customer - The database access object of customer.
=head1 SYNOPSIS
my $customer_dao = Peace::DAO::Customer->new(
dbh => $dbh,
);
$customer_dao->create( customer => $customer );
my $customer = $customer_dao->recover_by_uuid(
uuid => $uuid,
);
=head1 DESCRIPTION
Peace::DAO::Customer allows you to make database
operations over the customers table like recover
or create.
=head1 INSTANCE METHODS
Peace::DAO::Customer implements the following instance
methods:
=head2 new
my $customer_dao = Peace::DAO::Customer->new(
dbh => $dbh,
);
Takes a database handle and instances a Peace::DAO::Customer object.
=head1 METHODS
=head2 create
$customer_dao->create(
customer => $customer,
);
Takes a L<Peace::Model::Customer> object and creates its
database representation.
As a side effect sets the fields uuid and date_creation
in the passed object.
=head2 recover_by_uuid
my $customer = $customer_dao->recover_by_uuid(
uuid => $uuid,
);
=head1 SEE ALSO
L<Peace::DB>, L<DBI>, L<Peace::Model::Customer>

8
lib/Peace/DAO/Developer.pm
View File

@ -111,8 +111,9 @@ Peace::DAO::Developer - The database access object of developers.
=head1 DESCRIPTION =head1 DESCRIPTION
Peace::DAO::Developer allows you to make database operations over the Peace::DAO::Developer allows you to make database
developers table like recover or create. operations over the developers table like recover
or create.
=head1 INSTANCE METHODS =head1 INSTANCE METHODS
@ -134,6 +135,9 @@ Peace::DAO::Developer implements the following methods:
Creates a representation in database of the passed developer object. Creates a representation in database of the passed developer object.
As a side effect sets the fields uuid and date_creation
in the passed object.
=head2 recover_by_uuid =head2 recover_by_uuid
my $developer = $developer_dao->recover_by_uuid( uuid => $uuid ); my $developer = $developer_dao->recover_by_uuid( uuid => $uuid );

2
t/00009-pod-coverage.t
View File

@ -5,7 +5,7 @@ use v5.30.0;
use strict; use strict;
use warnings; use warnings;
use Test::Most tests => 1; use Test::Most tests => 9;
use Test::Pod::Coverage; use Test::Pod::Coverage;
{ {