Adding the generated html. (Some of it is still a stub.)

This commit is contained in:
sergiotarxz 2022-03-17 05:09:36 +01:00
parent ddf1753c71
commit 0b0a8991c3
9 changed files with 327 additions and 0 deletions

37
doc/lib/Peace.pm.html Normal file
View File

@ -0,0 +1,37 @@
<?xml version="1.0" ?>
<!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">
<head>
<title>Peace - Onlie GNU/Linux flatpak apps store.</title>
<meta http-equiv="content-type" content="text/html; charset=utf-8" />
<link rev="made" href="mailto:Alpine@build-edge-aarch64.nonet" />
</head>
<body>
<ul id="index">
<li><a href="#NAME">NAME</a></li>
<li><a href="#SYNOPSIS">SYNOPSIS</a></li>
<li><a href="#DESCRIPTION">DESCRIPTION</a></li>
</ul>
<h1 id="NAME">NAME</h1>
<p>Peace - Onlie GNU/Linux flatpak apps store.</p>
<h1 id="SYNOPSIS">SYNOPSIS</h1>
<pre><code>./peace</code></pre>
<h1 id="DESCRIPTION">DESCRIPTION</h1>
<p>Peace is the server backend for flatstore a shop to be able to sell or buy flatpak applications.</p>
</body>
</html>

View File

@ -0,0 +1,19 @@
<?xml version="1.0" ?>
<!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">
<head>
<title></title>
<meta http-equiv="content-type" content="text/html; charset=utf-8" />
<link rev="made" href="mailto:Alpine@build-edge-aarch64.nonet" />
</head>
<body>
</body>
</html>

View File

@ -0,0 +1,19 @@
<?xml version="1.0" ?>
<!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">
<head>
<title></title>
<meta http-equiv="content-type" content="text/html; charset=utf-8" />
<link rev="made" href="mailto:Alpine@build-edge-aarch64.nonet" />
</head>
<body>
</body>
</html>

View File

@ -0,0 +1,19 @@
<?xml version="1.0" ?>
<!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">
<head>
<title></title>
<meta http-equiv="content-type" content="text/html; charset=utf-8" />
<link rev="made" href="mailto:Alpine@build-edge-aarch64.nonet" />
</head>
<body>
</body>
</html>

View File

@ -0,0 +1,19 @@
<?xml version="1.0" ?>
<!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">
<head>
<title></title>
<meta http-equiv="content-type" content="text/html; charset=utf-8" />
<link rev="made" href="mailto:Alpine@build-edge-aarch64.nonet" />
</head>
<body>
</body>
</html>

70
doc/lib/Peace/DB.pm.html Normal file
View File

@ -0,0 +1,70 @@
<?xml version="1.0" ?>
<!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">
<head>
<title>Peace::DB - Database handler generator for the Peace shop.</title>
<meta http-equiv="content-type" content="text/html; charset=utf-8" />
<link rev="made" href="mailto:Alpine@build-edge-aarch64.nonet" />
</head>
<body>
<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="#FUNCTIONS">FUNCTIONS</a>
<ul>
<li><a href="#dbh">dbh</a></li>
<li><a href="#run_migrations">run_migrations</a></li>
</ul>
</li>
<li><a href="#SEE-ALSO">SEE ALSO</a></li>
</ul>
<h1 id="NAME">NAME</h1>
<p>Peace::DB - Database handler generator for the Peace shop.</p>
<h1 id="SYNOPSIS">SYNOPSIS</h1>
<pre><code>my $config =
$self-&gt;plugin(
JSONConfig =&gt; {
file =&gt; &quot;$home/.config/peace/peace.conf&quot;
}
);
my $dbh = Peace::DB-&gt;dbh( config =&gt; $config );</code></pre>
<h1 id="DESCRIPTION">DESCRIPTION</h1>
<p>This module helps to recover a database handle and runs the migrations automatically when doing so.</p>
<h1 id="FUNCTIONS">FUNCTIONS</h1>
<p>Peace::DB implements the following functions:</p>
<h2 id="dbh">dbh</h2>
<p>Recovers a database handle, requires the config of the app as its parameter.</p>
<pre><code>my $dbh = Peace::DB-&gt;dbh( config =&gt; $config );</code></pre>
<h2 id="run_migrations">run_migrations</h2>
<p>Runs the migrations manually.</p>
<pre><code>Peace::DB-&gt;run_migrations($dbh);</code></pre>
<h1 id="SEE-ALSO">SEE ALSO</h1>
<p><a>DBI</a>, <a>DBD::Pg</a></p>
</body>
</html>

View File

@ -0,0 +1,19 @@
<?xml version="1.0" ?>
<!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">
<head>
<title></title>
<meta http-equiv="content-type" content="text/html; charset=utf-8" />
<link rev="made" href="mailto:Alpine@build-edge-aarch64.nonet" />
</head>
<body>
</body>
</html>

View File

@ -0,0 +1,106 @@
<?xml version="1.0" ?>
<!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">
<head>
<title>Peace::Model::Customer - The customer object representation</title>
<meta http-equiv="content-type" content="text/html; charset=utf-8" />
<link rev="made" href="mailto:Alpine@build-edge-aarch64.nonet" />
</head>
<body>
<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="#uuid">uuid</a></li>
<li><a href="#date_creation">date_creation</a></li>
<li><a href="#secret_bcrypt">secret_bcrypt</a></li>
<li><a href="#stripe_id">stripe_id</a></li>
</ul>
</li>
<li><a href="#SEE-ALSO">SEE ALSO</a></li>
</ul>
<h1 id="NAME">NAME</h1>
<p>Peace::Model::Customer - The customer object representation</p>
<h1 id="SYNOPSIS">SYNOPSIS</h1>
<pre><code>my $customer = Peace::Model::Customer-&gt;new(
secret_bcrypt =&gt; $secret_bcrypt
);</code></pre>
<h1 id="DESCRIPTION">DESCRIPTION</h1>
<p>Describes a customer of Peace capable of buy applications.</p>
<h1 id="INSTANCE-METHODS">INSTANCE METHODS</h1>
<p>Peace::Model::Customer implements the following instance methods:</p>
<h2 id="new">new</h2>
<pre><code>my $customer = Peace::Model::Customer-&gt;new(
uuid =&gt; $uuid, # optional
date_creation =&gt; $date_creation, # optional
secret_bcrypt =&gt; $secret_bcrypt,
stripe_id =&gt; $stripe_id, # optional
);</code></pre>
<p>Instances a new Peace::Model::Customer.</p>
<h1 id="METHODS">METHODS</h1>
<p>Peace::Model::Customer implements the following methods:</p>
<h2 id="uuid">uuid</h2>
<pre><code>my $uuid = $customer-&gt;uuid;
$customer-&gt;uuid($uuid);</code></pre>
<p>Allows to retrive and set the customer uuid.</p>
<h2 id="date_creation">date_creation</h2>
<pre><code>my $date_creation = $customer-&gt;date_creation;
$customer-&gt;date_creation($date_creation);</code></pre>
<p>Allows to retrive and set the customer date_creation.</p>
<h2 id="secret_bcrypt">secret_bcrypt</h2>
<pre><code>my $secret_bcrypt = $customer-&gt;secret_bcrypt;
$customer-&gt;secret_bcrypt($secret_bcrypt);</code></pre>
<p>Allows to retrive and set the customer secret_bcrypt.</p>
<h2 id="stripe_id">stripe_id</h2>
<pre><code>my $stripe_id = $customer-&gt;stripe_id;
$customer-&gt;stripe_id($stripe_id);</code></pre>
<h1 id="SEE-ALSO">SEE ALSO</h1>
<p><a>Peace::DAO::Customer</a></p>
</body>
</html>

View File

@ -0,0 +1,19 @@
<?xml version="1.0" ?>
<!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">
<head>
<title></title>
<meta http-equiv="content-type" content="text/html; charset=utf-8" />
<link rev="made" href="mailto:Alpine@build-edge-aarch64.nonet" />
</head>
<body>
</body>
</html>