Skip to content

Instantly share code, notes, and snippets.

@mvriel

mvriel/api-contents.html

Created April 9, 2011 21:35
Show Gist options
  • Save mvriel/911800 to your computer and use it in GitHub Desktop.
Save mvriel/911800 to your computer and use it in GitHub Desktop.
Download ZIP
Raw
api-contents.html
<?xml version="1.0" encoding="UTF-8"?><!DOCTYPE html
PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<title></title>
<link rel="stylesheet" href="theme.css" type="text/css" />
</head>
<body>
<h1>/path/to/my/file.php</h1>
<h2>Description</h2>
<p>This is the short description for this file</p>
<p>This is the long description for this file</p>
<p class="file-info">
<dl>
<dt>Author</dt>
<dd>Mike van Riel &lt;[email protected]&gt;</dd>
<dt>License</dt>
<dd>MIT</dd>
<dt>Version</dt>
<dd>1.0</dd>
</dl>
<dl>
<dt>Constants</dt>
<dd>CONSTANT1</dd>
<dt>Functions</dt>
<dd>getFunction1</dd>
<dt>Classes</dt>
<dd>Class1</dd>
<dd>Class2</dd>
</dl>
</p>
<h2>Constants</h2>
<div>
<h3 class="constant">Constant1</h3>
<div class="constant">
<p><code>int CONSTANT1 = 'value'</code></p>
<p>Short description for Constant1</p>
<p>Long description for Constant1</p>
<p class="constant-info">
<dl>
<dt>type</dt>
<dd>int</dd>
<dt>value</dt>
<dd>'value'</dd>
<dt>see</dt>
<dd>self::CONSTANT2</dd>
</dl>
</p>
</div>
</div>
<h2>Functions</h2>
<div>
<h3 class="function">Function1</h3>
<div class="function">
<p><code>int Function1(int $name)</code></p>
<p>Short description for Constant1</p>
<p>Long description for Constant1</p>
<h4>Arguments</h4>
<p class="arguments">
<h5>name</h5>
<p>Description</p>
<dl>
<dt>type</dt>
<dd>int</dd>
<dt>default</dt>
<dd>1</dd>
</dl>
</p>
<p class="constant-info">
<dl>
<dt>see</dt>
<dd>self::CONSTANT2</dd>
<dd>Description</dd>
<dt>return</dt>
<dd>int</dd>
</dl>
</p>
</div>
</div>
<h2 class="class">Class1</h2>
<div class="class">
<h3>Description</h3>
<p>Short description</p>
<p>Long description</p>
<p class="class-info">
<dl>
<dt>Author</dt>
<dd>Mike van Riel &lt;[email protected]&gt;</dd>
<dt>License</dt>
<dd>MIT</dd>
<dt>Version</dt>
<dd>1.0</dd>
</dl>
<dl>
<dt>Constants</dt>
<dd>Constant1</dd>
<dt>Properties</dt>
<dd>Property1</dd>
<dt>Methods</dt>
<dd>Method1</dd>
</dl>
</p>
<h3 class="constant">CONSTANT1</h3>
<div class="constant">
<p><code>int CONSTANT1 = 'value'</code></p>
<p>Short description for Constant1</p>
<p>Long description for Constant1</p>
<p class="constant-info">
<dl>
<dt>see</dt>
<dd>self::CONSTANT2</dd>
</dl>
</p>
</div>
<h3 class="property">Property1</h3>
<div class="property">
<p>Description</p>
<dl>
<dt>type</dt>
<dd>int</dd>
<dt>default</dt>
<dd>1</dd>
</dl>
</div>
<h3>Method1</h3>
<div class="method">
<p><code>int Function1(int $name)</code></p>
<p>Short description for Constant1</p>
<p>Long description for Constant1</p>
<h4>Arguments</h4>
<p class="arguments">
<h5>name</h5>
<p>Description</p>
<dl>
<dt>type</dt>
<dd>int</dd>
<dt>default</dt>
<dd>1</dd>
</dl>
</p>
<p class="constant-info">
<dl>
<dt>see</dt>
<dd>self::CONSTANT2</dd>
<dd>Description</dd>
<dt>return</dt>
<dd>int</dd>
</dl>
</p>
</div>
</div>
<h2 class="interface">Interface1</h2>
<div class="interface">
<h3 class="constant">CONSTANT1</h3>
<div class="constant">
<p><code>int CONSTANT1 = 'value'</code></p>
<p>Short description for Constant1</p>
<p>Long description for Constant1</p>
<p class="constant-info">
<dl>
<dt>see</dt>
<dd>self::CONSTANT2</dd>
</dl>
</p>
</div>
<h3 class="property">Property1</h3>
<div class="property">
<p>Description</p>
<dl>
<dt>type</dt>
<dd>int</dd>
<dt>default</dt>
<dd>1</dd>
</dl>
</div>
<h3>Method1</h3>
<div class="method">
<p><code>int Function1(int $name)</code></p>
<p>Short description for Constant1</p>
<p>Long description for Constant1</p>
<h4>Arguments</h4>
<p class="arguments">
<h5>name</h5>
<p>Description</p>
<dl>
<dt>type</dt>
<dd>int</dd>
<dt>default</dt>
<dd>1</dd>
</dl>
</p>
<p class="constant-info">
<dl>
<dt>see</dt>
<dd>self::CONSTANT2</dd>
<dd>Description</dd>
<dt>return</dt>
<dd>int</dd>
</dl>
</p>
</div>
</div>
</body>
</html>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment