aboutsummaryrefslogtreecommitdiff
path: root/docs/graphs
diff options
context:
space:
mode:
authorCamil Staps2015-02-07 21:06:17 +0100
committerCamil Staps2015-02-07 21:06:17 +0100
commit29955216d69ca08b69afe1ace71151839049c045 (patch)
tree48a085e24cf1e65677bbace195017f118292ecc2 /docs/graphs
parentAdded some documentation; added Makefile for generating docs with phpdoc (diff)
Added documentation
Diffstat (limited to 'docs/graphs')
-rw-r--r--docs/graphs/class.html163
-rw-r--r--docs/graphs/classes.svg72
2 files changed, 235 insertions, 0 deletions
diff --git a/docs/graphs/class.html b/docs/graphs/class.html
new file mode 100644
index 0000000..940d66c
--- /dev/null
+++ b/docs/graphs/class.html
@@ -0,0 +1,163 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+ <meta name="viewport" content="width=device-width, initial-scale=1.0, maximum-scale=1.0, user-scalable=0"/>
+ <meta charset="utf-8"/>
+ <title>API Documentation</title>
+ <meta name="author" content=""/>
+ <meta name="description" content=""/>
+
+ <link href="../css/bootstrap-combined.no-icons.min.css" rel="stylesheet">
+ <link href="../css/font-awesome.min.css" rel="stylesheet">
+ <link href="../css/prism.css" rel="stylesheet" media="all"/>
+ <link href="../css/template.css" rel="stylesheet" media="all"/>
+ <link href="../css/jquery.iviewer.css" rel="stylesheet" media="all"/>
+ <style>
+ #viewer {
+ position: relative;
+ width: 100%;
+ }
+ .wrapper {
+ overflow: hidden;
+ }
+ </style>
+
+ <!--[if lt IE 9]>
+ <script src="../js/html5.js"></script>
+ <![endif]-->
+ <script src="../js/jquery-1.11.0.min.js"></script>
+ <script src="../js/ui/1.10.4/jquery-ui.min.js"></script>
+ <script src="../js/bootstrap.min.js"></script>
+ <script src="../js/jquery.smooth-scroll.js"></script>
+ <script src="../js/prism.min.js"></script>
+ <!-- TODO: Add http://jscrollpane.kelvinluck.com/ to style the scrollbars for browsers not using webkit-->
+ <script src="../js/jquery.mousewheel.js" type="text/javascript"></script>
+ <script src="../js/jquery.iviewer.js" type="text/javascript"></script>
+ <script type="text/javascript">
+ $(window).resize(function(){
+ $("#viewer").height($(window).height() - 100);
+ });
+
+ $(document).ready(function() {
+ $("#viewer").iviewer({src: '../graphs/classes.svg', zoom_animation: false});
+ $('#viewer img').bind('dragstart', function(event){
+ event.preventDefault();
+ });
+ $(window).resize();
+ });
+ </script>
+
+ <link rel="shortcut icon" href="../images/favicon.ico"/>
+ <link rel="apple-touch-icon" href="../images/apple-touch-icon.png"/>
+ <link rel="apple-touch-icon" sizes="72x72" href="../images/apple-touch-icon-72x72.png"/>
+ <link rel="apple-touch-icon" sizes="114x114" href="../images/apple-touch-icon-114x114.png"/>
+</head>
+<body>
+
+<div class="navbar navbar-fixed-top">
+ <div class="navbar-inner">
+ <div class="container">
+ <a class="btn btn-navbar" data-toggle="collapse" data-target=".nav-collapse">
+ <i class="icon-ellipsis-vertical"></i>
+ </a>
+ <a class="brand" href="../index.html">API Documentation</a>
+
+ <div class="nav-collapse">
+ <ul class="nav pull-right">
+ <li class="dropdown" id="charts-menu">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">
+ Charts <b class="caret"></b>
+ </a>
+ <ul class="dropdown-menu">
+ <li>
+ <a href="../graphs/class.html">
+ <i class="icon-list-alt"></i>&#160;Class hierarchy diagram
+ </a>
+ </li>
+ </ul>
+ </li>
+ <li class="dropdown" id="reports-menu">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">
+ Reports <b class="caret"></b>
+ </a>
+ <ul class="dropdown-menu">
+ <li>
+ <a href="../reports/errors.html">
+ <i class="icon-list-alt"></i>&#160;Errors <span class="label label-info pull-right">50</span>
+ </a>
+ </li>
+ <li>
+ <a href="../reports/markers.html">
+ <i class="icon-list-alt"></i>&#160;Markers <span class="label label-info pull-right">1</span>
+ </a>
+ </li>
+ <li>
+ <a href="../reports/deprecated.html">
+ <i class="icon-list-alt"></i>&#160;Deprecated <span class="label label-info pull-right">0</span>
+ </a>
+ </li>
+ </ul>
+ </li>
+ </ul>
+ </div>
+ </div>
+ </div>
+ <!--<div class="go_to_top">-->
+ <!--<a href="#___" style="color: inherit">Back to top&#160;&#160;<i class="icon-upload icon-white"></i></a>-->
+ <!--</div>-->
+</div>
+
+<div id="___" class="container-fluid">
+ <div class="row-fluid">
+ <div class="span12">
+ <div class="wrapper">
+ <div id="viewer" class="viewer"></div>
+ </div>
+ </div>
+ </div>
+
+ <footer class="row-fluid">
+ <section class="span10 offset2">
+ <section class="row-fluid">
+ <section class="span10 offset1">
+ <section class="row-fluid footer-sections">
+ <section class="span4">
+ <h1><i class="icon-code"></i></h1>
+ <div>
+ <ul>
+ </ul>
+ </div>
+ </section>
+ <section class="span4">
+ <h1><i class="icon-bar-chart"></i></h1>
+ <div>
+ <ul>
+ <li><a href="../graphs/class.html">Class Hierarchy Diagram</a></li>
+ </ul>
+ </div>
+ </section>
+ <section class="span4">
+ <h1><i class="icon-pushpin"></i></h1>
+ <div>
+ <ul>
+ <li><a href="../reports/errors.html">Errors</a></li>
+ <li><a href="../reports/markers.html">Markers</a></li>
+ </ul>
+ </div>
+ </section>
+ </section>
+ </section>
+ </section>
+ <section class="row-fluid">
+ <section class="span10 offset1">
+ <hr />
+ Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor </a> and authored
+ on February 7th, 2015 at 21:04.
+ </section>
+ </section>
+ </section>
+ </footer>
+</div>
+
+</body>
+</html>
diff --git a/docs/graphs/classes.svg b/docs/graphs/classes.svg
new file mode 100644
index 0000000..69b386e
--- /dev/null
+++ b/docs/graphs/classes.svg
@@ -0,0 +1,72 @@
+<?xml version="1.0" encoding="UTF-8" standalone="no"?>
+<!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN"
+ "http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd">
+<!-- Generated by graphviz version 2.36.0 (20140111.2315)
+ -->
+<!-- Title: G Pages: 1 -->
+<svg width="278pt" height="528pt"
+ viewBox="0.00 0.00 278.00 528.00" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink">
+<g id="graph0" class="graph" transform="scale(1 1) rotate(0) translate(4 524)">
+<title>G</title>
+<polygon fill="white" stroke="none" points="-4,4 -4,-524 274,-524 274,4 -4,4"/>
+<g id="clust1" class="cluster"><title>cluster_Global</title>
+<path fill="none" stroke="gray" d="M146,-8C146,-8 250,-8 250,-8 256,-8 262,-14 262,-20 262,-20 262,-500 262,-500 262,-506 256,-512 250,-512 250,-512 146,-512 146,-512 140,-512 134,-506 134,-500 134,-500 134,-20 134,-20 134,-14 140,-8 146,-8"/>
+<text text-anchor="middle" x="198" y="-499.2" font-family="Times,serif" font-size="11.00" fill="gray">Global</text>
+</g>
+<!-- \\file -->
+<g id="node1" class="node"><title>\\file</title>
+<polygon fill="none" stroke="black" points="225,-484 171,-484 171,-448 225,-448 225,-484"/>
+<text text-anchor="middle" x="198" y="-463.2" font-family="Courier,monospace" font-size="11.00">file</text>
+</g>
+<!-- \\correspondence -->
+<g id="node2" class="node"><title>\\correspondence</title>
+<polygon fill="none" stroke="black" points="253.5,-430 142.5,-430 142.5,-394 253.5,-394 253.5,-430"/>
+<text text-anchor="middle" x="198" y="-409.2" font-family="Courier,monospace" font-size="11.00">correspondence</text>
+</g>
+<!-- \\FPDF -->
+<g id="node10" class="node"><title>\\FPDF</title>
+<ellipse fill="none" stroke="black" cx="35" cy="-412" rx="34.394" ry="18"/>
+<text text-anchor="middle" x="35" y="-408.3" font-family="Times,serif" font-size="14.00" fill="gray">\FPDF</text>
+</g>
+<!-- \\correspondence&#45;&gt;\\FPDF -->
+<g id="edge1" class="edge"><title>\\correspondence&#45;&gt;\\FPDF</title>
+<path fill="none" stroke="black" d="M142.493,-412C122.078,-412 99.1654,-412 79.838,-412"/>
+<polygon fill="none" stroke="black" points="79.8,-408.5 69.7999,-412 79.7999,-415.5 79.8,-408.5"/>
+</g>
+<!-- \\client -->
+<g id="node3" class="node"><title>\\client</title>
+<polygon fill="none" stroke="black" points="226.5,-376 169.5,-376 169.5,-340 226.5,-340 226.5,-376"/>
+<text text-anchor="middle" x="198" y="-355.2" font-family="Courier,monospace" font-size="11.00">client</text>
+</g>
+<!-- \\assignment -->
+<g id="node4" class="node"><title>\\assignment</title>
+<polygon fill="none" stroke="black" points="240,-322 156,-322 156,-286 240,-286 240,-322"/>
+<text text-anchor="middle" x="198" y="-301.2" font-family="Courier,monospace" font-size="11.00">assignment</text>
+</g>
+<!-- \\response -->
+<g id="node5" class="node"><title>\\response</title>
+<polygon fill="none" stroke="black" points="233.5,-268 162.5,-268 162.5,-232 233.5,-232 233.5,-268"/>
+<text text-anchor="middle" x="198" y="-247.2" font-family="Courier,monospace" font-size="11.00">response</text>
+</g>
+<!-- \\contact -->
+<g id="node6" class="node"><title>\\contact</title>
+<polygon fill="none" stroke="black" points="230,-214 166,-214 166,-178 230,-178 230,-214"/>
+<text text-anchor="middle" x="198" y="-193.2" font-family="Courier,monospace" font-size="11.00">contact</text>
+</g>
+<!-- \\BusinessAdmin -->
+<g id="node7" class="node"><title>\\BusinessAdmin</title>
+<polygon fill="none" stroke="black" points="250,-160 146,-160 146,-124 250,-124 250,-160"/>
+<text text-anchor="middle" x="198" y="-139.2" font-family="Courier,monospace" font-size="11.00">BusinessAdmin</text>
+</g>
+<!-- \\offer -->
+<g id="node8" class="node"><title>\\offer</title>
+<polygon fill="none" stroke="black" points="225,-106 171,-106 171,-70 225,-70 225,-106"/>
+<text text-anchor="middle" x="198" y="-85.2" font-family="Courier,monospace" font-size="11.00">offer</text>
+</g>
+<!-- \\constants -->
+<g id="node9" class="node"><title>\\constants</title>
+<polygon fill="none" stroke="black" points="236.5,-52 159.5,-52 159.5,-16 236.5,-16 236.5,-52"/>
+<text text-anchor="middle" x="198" y="-31.2" font-family="Courier,monospace" font-size="11.00">constants</text>
+</g>
+</g>
+</svg>
generated by cgit v1.2.3 (git 2.39.1) at 2025-04-30 06:47:44 +0000