Adding documentation for the Peace::DAO::Developer object.

This commit is contained in:
sergiotarxz 2022-03-18 01:17:25 +01:00
parent b17bc3b8dc
commit ce8df4567b
2 changed files with 113 additions and 1 deletions

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::Developer - The database access object of developers.</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,70 @@
<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::Developer - The database access object of developers.</p>
<h1 id="SYNOPSIS">SYNOPSIS</h1>
<pre><code>my $developer_dao = Peace::DAO::Developer-&gt;new( dbh =&gt; $dbh );
$developer_dao-&gt;create( developer =&gt; $developer);
my $developer = $developer_dao-&gt;recover_by_uuid( uuid =&gt; $uuid );</code></pre>
<h1 id="DESCRIPTION">DESCRIPTION</h1>
<p>Peace::DAO::Developer allows you to make database operations over the developers table like recover or create.</p>
<h1 id="INSTANCE-METHODS">INSTANCE METHODS</h1>
<p>Peace::DAO::Developer implements the following instance methods:</p>
<h2 id="new">new</h2>
<pre><code>my $developer_dao = Peace::DAO::Developer-&gt;new( dbh =&gt; $dbh );</code></pre>
<p>Builds a Peace::DAO::Developer object.</p>
<h1 id="METHODS">METHODS</h1>
<p>Peace::DAO::Developer implements the following methods:</p>
<h2 id="create">create</h2>
<pre><code>$developer_dao-&gt;create( developer =&gt; $developer );</code></pre>
<p>Creates a representation in database of the passed developer object.</p>
<h2 id="recover_by_uuid">recover_by_uuid</h2>
<pre><code>my $developer = $developer_dao-&gt;recover_by_uuid( uuid =&gt; $uuid );</code></pre>
<p>Recovers the developer associated from an uuid from database.</p>
<h1 id="SEE-ALSO">SEE ALSO</h1>
<p><a href="../DB.pm.html">Peace::DB</a>, <a href="../Model/Developer.pm.html">Peace::Model::Developer</a></p>
</body> </body>

View File

@ -95,3 +95,51 @@ sub _dbh {
return $self->{dbh}; return $self->{dbh};
} }
1; 1;
=encoding utf8
=head1 NAME
Peace::DAO::Developer - The database access object of developers.
=head1 SYNOPSIS
my $developer_dao = Peace::DAO::Developer->new( dbh => $dbh );
$developer_dao->create( developer => $developer);
my $developer = $developer_dao->recover_by_uuid( uuid => $uuid );
=head1 DESCRIPTION
Peace::DAO::Developer allows you to make database operations over the
developers table like recover or create.
=head1 INSTANCE METHODS
Peace::DAO::Developer implements the following instance methods:
=head2 new
my $developer_dao = Peace::DAO::Developer->new( dbh => $dbh );
Builds a Peace::DAO::Developer object.
=head1 METHODS
Peace::DAO::Developer implements the following methods:
=head2 create
$developer_dao->create( developer => $developer );
Creates a representation in database of the passed developer object.
=head2 recover_by_uuid
my $developer = $developer_dao->recover_by_uuid( uuid => $uuid );
Recovers the developer associated from an uuid from database.
=head1 SEE ALSO
L<Peace::DB>, L<Peace::Model::Developer>