Skip to content

Commit

Permalink
updated docset
Browse files Browse the repository at this point in the history
  • Loading branch information
@pfefferle
pfefferle committed Jun 22, 2016
1 parent f56fbca commit f47072a
Show file tree
Hide file tree
Showing 9 changed files with 47 additions and 24 deletions.
4 changes: 2 additions & 2 deletions apiDoc.docset/Contents/Resources/Documents/apidocjs.com/deprecated.html
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<!DOCTYPE html>
<html><!-- Mirrored from apidocjs.com/deprecated.html by HTTrack Website Copier/3.x [XR&CO'2014], Tue, 06 Oct 2015 07:20:48 GMT --><!-- Added by HTTrack --><head><meta content="text/html;charset=utf-8" http-equiv="content-type"/><!-- /Added by HTTrack -->
<html><!-- Mirrored from apidocjs.com/deprecated.html by HTTrack Website Copier/3.x [XR&CO'2014], Wed, 22 Jun 2016 19:51:57 GMT --><!-- Added by HTTrack --><head><meta content="text/html;charset=utf-8" http-equiv="content-type"/><!-- /Added by HTTrack -->

<title>apiDoc - Deprecated apiDoc params</title>
<meta content="width=device-width, initial-scale=1.0" name="viewport"/>
Expand Down Expand Up @@ -709,4 +709,4 @@ <h1>MIT License</h1>



</body><!-- Mirrored from apidocjs.com/deprecated.html by HTTrack Website Copier/3.x [XR&CO'2014], Tue, 06 Oct 2015 07:20:49 GMT --></html>
</body><!-- Mirrored from apidocjs.com/deprecated.html by HTTrack Website Copier/3.x [XR&CO'2014], Wed, 22 Jun 2016 19:51:57 GMT --></html>
4 changes: 2 additions & 2 deletions apiDoc.docset/Contents/Resources/Documents/apidocjs.com/example/index.html
View file
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<!DOCTYPE html>
<html>

<!-- Mirrored from apidocjs.com/example/ by HTTrack Website Copier/3.x [XR&CO'2014], Tue, 06 Oct 2015 07:20:49 GMT -->
<!-- Mirrored from apidocjs.com/example/ by HTTrack Website Copier/3.x [XR&CO'2014], Wed, 22 Jun 2016 19:51:57 GMT -->
<!-- Added by HTTrack --><meta http-equiv="content-type" content="text/html;charset=utf-8" /><!-- /Added by HTTrack -->
<head>
<title>Loading...</title>
Expand Down Expand Up @@ -659,5 +659,5 @@ <h2><del>{{__ compare.key}}</del></h2>
<script data-main="main.js" src="vendor/require.min.js"></script>
</body>

<!-- Mirrored from apidocjs.com/example/ by HTTrack Website Copier/3.x [XR&CO'2014], Tue, 06 Oct 2015 07:20:51 GMT -->
<!-- Mirrored from apidocjs.com/example/ by HTTrack Website Copier/3.x [XR&CO'2014], Wed, 22 Jun 2016 19:51:59 GMT -->
</html>
4 changes: 2 additions & 2 deletions apiDoc.docset/Contents/Resources/Documents/apidocjs.com/example_basic/index.html
View file
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<!DOCTYPE html>
<html>

<!-- Mirrored from apidocjs.com/example_basic/ by HTTrack Website Copier/3.x [XR&CO'2014], Tue, 06 Oct 2015 07:20:51 GMT -->
<!-- Mirrored from apidocjs.com/example_basic/ by HTTrack Website Copier/3.x [XR&CO'2014], Wed, 22 Jun 2016 19:51:59 GMT -->
<!-- Added by HTTrack --><meta http-equiv="content-type" content="text/html;charset=utf-8" /><!-- /Added by HTTrack -->
<head>
<title>Loading...</title>
Expand Down Expand Up @@ -659,5 +659,5 @@ <h2><del>{{__ compare.key}}</del></h2>
<script data-main="main.js" src="vendor/require.min.js"></script>
</body>

<!-- Mirrored from apidocjs.com/example_basic/ by HTTrack Website Copier/3.x [XR&CO'2014], Tue, 06 Oct 2015 07:20:53 GMT -->
<!-- Mirrored from apidocjs.com/example_basic/ by HTTrack Website Copier/3.x [XR&CO'2014], Wed, 22 Jun 2016 19:52:01 GMT -->
</html>
4 changes: 2 additions & 2 deletions apiDoc.docset/Contents/Resources/Documents/apidocjs.com/example_inherit/index.html
View file
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<!DOCTYPE html>
<html>

<!-- Mirrored from apidocjs.com/example_inherit/ by HTTrack Website Copier/3.x [XR&CO'2014], Tue, 06 Oct 2015 07:20:53 GMT -->
<!-- Mirrored from apidocjs.com/example_inherit/ by HTTrack Website Copier/3.x [XR&CO'2014], Wed, 22 Jun 2016 19:52:01 GMT -->
<!-- Added by HTTrack --><meta http-equiv="content-type" content="text/html;charset=utf-8" /><!-- /Added by HTTrack -->
<head>
<title>Loading...</title>
Expand Down Expand Up @@ -659,5 +659,5 @@ <h2><del>{{__ compare.key}}</del></h2>
<script data-main="main.js" src="vendor/require.min.js"></script>
</body>

<!-- Mirrored from apidocjs.com/example_inherit/ by HTTrack Website Copier/3.x [XR&CO'2014], Tue, 06 Oct 2015 07:20:54 GMT -->
<!-- Mirrored from apidocjs.com/example_inherit/ by HTTrack Website Copier/3.x [XR&CO'2014], Wed, 22 Jun 2016 19:52:03 GMT -->
</html>
4 changes: 2 additions & 2 deletions apiDoc.docset/Contents/Resources/Documents/apidocjs.com/example_versioning/index.html
View file
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<!DOCTYPE html>
<html>

<!-- Mirrored from apidocjs.com/example_versioning/ by HTTrack Website Copier/3.x [XR&CO'2014], Tue, 06 Oct 2015 07:20:54 GMT -->
<!-- Mirrored from apidocjs.com/example_versioning/ by HTTrack Website Copier/3.x [XR&CO'2014], Wed, 22 Jun 2016 19:52:03 GMT -->
<!-- Added by HTTrack --><meta http-equiv="content-type" content="text/html;charset=utf-8" /><!-- /Added by HTTrack -->
<head>
<title>Loading...</title>
Expand Down Expand Up @@ -659,5 +659,5 @@ <h2><del>{{__ compare.key}}</del></h2>
<script data-main="main.js" src="vendor/require.min.js"></script>
</body>

<!-- Mirrored from apidocjs.com/example_versioning/ by HTTrack Website Copier/3.x [XR&CO'2014], Tue, 06 Oct 2015 07:20:56 GMT -->
<!-- Mirrored from apidocjs.com/example_versioning/ by HTTrack Website Copier/3.x [XR&CO'2014], Wed, 22 Jun 2016 19:52:05 GMT -->
</html>
31 changes: 25 additions & 6 deletions apiDoc.docset/Contents/Resources/Documents/apidocjs.com/index-2.html
View file
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<!DOCTYPE html>
<html>

<!-- Mirrored from apidocjs.com/index.html by HTTrack Website Copier/3.x [XR&CO'2014], Tue, 06 Oct 2015 07:20:56 GMT -->
<!-- Mirrored from apidocjs.com/index.html by HTTrack Website Copier/3.x [XR&CO'2014], Wed, 22 Jun 2016 19:52:05 GMT -->
<!-- Added by HTTrack --><meta http-equiv="content-type" content="text/html;charset=utf-8" /><!-- /Added by HTTrack -->
<head>
<title>apiDoc - Inline Documentation for RESTful web APIs</title>
Expand Down Expand Up @@ -36,6 +36,7 @@ <h3>apiDoc creates a documentation from API annotations in your source code.</h3
<ul class="resp-tabs-list">
<li title="C#, Go, Dart, Java, JavaScript, PHP, TypeScript (all DocStyle capable languages)">Java, JavaScript, PHP, ...</li>
<li title="CoffeeScript">CoffeeScript</li>
<li title="Elixir">Elixir</li>
<li title="Erlang">Erlang</li>
<li title="Perl">Perl</li>
<li title="Python">Python</li>
Expand Down Expand Up @@ -70,6 +71,20 @@ <h3>apiDoc creates a documentation from API annotations in your source code.</h3
###</code></pre>
</div>

<!-- Tab Elixir -->
<div>
<pre class="example"><code>@apidoc """
@api {get} /user/:id Request User information
@apiName GetUser
@apiGroup User

@apiParam {Number} id Users unique ID.

@apiSuccess {String} firstname Firstname of the User.
@apiSuccess {String} lastname Lastname of the User.
"""</code></pre>
</div>

<!-- Tab Erlang -->
<div>
<pre class="example"><code>%{
Expand Down Expand Up @@ -230,6 +245,11 @@ <h2>Preface</h2>
This is a comment.
###</code></pre>

<p>Elixir</p>
<pre class="example"><code>@apidoc """
This is a comment.
"""</code></pre>

<p>Erlang (% within the comment is optional)</p>
<pre class="example"><code>%{
% This is a comment.
Expand Down Expand Up @@ -374,7 +394,7 @@ <h2>Configuration (apidoc.json)</h2>
"description": "apiDoc basic example",
"apidoc": {
"title": "Custom apiDoc browser title",
"url" : "https://api.github.com/v1",
"url" : "https://api.github.com/v1"
}
}</code></pre>

Expand Down Expand Up @@ -438,7 +458,7 @@ <h3 id="configuration-settings">Settings for apidoc.json</h3>

<tr>
<td class="code">order</td>
<td>A list of api-names / group-names for ordering the output. Not defined names are automatically displayd last.<br>
<td>A list of api-names / group-names for ordering the output. Not defined names are automatically displayed last.<br>
<pre><code>"order": [
"Error",
"Define",
Expand Down Expand Up @@ -738,13 +758,12 @@ <h2>Versioning</h2>

<article id="example-full">
<h2>Full example (all together)</h2>
<p>This is a complex example with <code>inherit</code>, <code>versioning</code>, <code>API.md</code> file and history file <code>_apidoc.js</code>, explanation is within code and generated documentation.</p>
<p>This is a complex example with <code>inherit</code>, <code>versioning</code> file and history file <code>_apidoc.js</code>, explanation is within code and generated documentation.</p>
<p><a href="example/index.html">View example output</a></p>
<p><br></p>
<p>Files:</p>
<ul>
<li><a href="source/example_full/_apidoc.js">_apidoc.js</a></li>
<li><a href="source/example_full/API.html">API.md</a></li>
<li><a href="source/example_full/example.js">example.js</a></li>
<li><a href="source/example_full/apidoc.json">apidoc.json</a></li>
</ul>
Expand Down Expand Up @@ -1801,5 +1820,5 @@ <h1>MIT License</h1>
</script>
</body>

<!-- Mirrored from apidocjs.com/index.html by HTTrack Website Copier/3.x [XR&CO'2014], Tue, 06 Oct 2015 07:20:56 GMT -->
<!-- Mirrored from apidocjs.com/index.html by HTTrack Website Copier/3.x [XR&CO'2014], Wed, 22 Jun 2016 19:52:05 GMT -->
</html>
16 changes: 10 additions & 6 deletions apiDoc.docset/Contents/Resources/Documents/apidocjs.com/index.html
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<!DOCTYPE html>
<html><!-- Mirrored from apidocjs.com/ by HTTrack Website Copier/3.x [XR&CO'2014], Tue, 06 Oct 2015 07:20:43 GMT --><!-- Added by HTTrack --><head><meta content="text/html;charset=utf-8" http-equiv="content-type"/><!-- /Added by HTTrack -->
<html><!-- Mirrored from apidocjs.com/ by HTTrack Website Copier/3.x [XR&CO'2014], Wed, 22 Jun 2016 19:51:52 GMT --><!-- Added by HTTrack --><head><meta content="text/html;charset=utf-8" http-equiv="content-type"/><!-- /Added by HTTrack -->

<title>apiDoc - Inline Documentation for RESTful web APIs</title>
<meta content="width=device-width, initial-scale=1.0" name="viewport"/>
Expand Down Expand Up @@ -117,6 +117,11 @@ <h2><a class="dashAnchor" name="//apple_ref/cpp/Guide/Preface"></a>Preface</h2>
This is a comment.
###</code></pre>

<p>Elixir</p>
<pre class="example"><code>@apidoc """
This is a comment.
"""</code></pre>

<p>Erlang (% within the comment is optional)</p>
<pre class="example"><code>%{
% This is a comment.
Expand Down Expand Up @@ -261,7 +266,7 @@ <h2><a class="dashAnchor" name="//apple_ref/cpp/Guide/Configuration%20%28apidoc.
"description": "apiDoc basic example",
"apidoc": {
"title": "Custom apiDoc browser title",
"url" : "https://api.github.com/v1",
"url" : "https://api.github.com/v1"
}
}</code></pre>

Expand Down Expand Up @@ -325,7 +330,7 @@ <h3 id="configuration-settings">Settings for apidoc.json</h3>

<tr>
<td class="code">order</td>
<td>A list of api-names / group-names for ordering the output. Not defined names are automatically displayd last.<br/>
<td>A list of api-names / group-names for ordering the output. Not defined names are automatically displayed last.<br/>
<pre><code>"order": [
"Error",
"Define",
Expand Down Expand Up @@ -625,13 +630,12 @@ <h2><a class="dashAnchor" name="//apple_ref/cpp/Sample/Versioning"></a>Versionin

<article id="example-full">
<h2><a class="dashAnchor" name="//apple_ref/cpp/Sample/Full%20example%20%28all%20together%29"></a>Full example (all together)</h2>
<p>This is a complex example with <code>inherit</code>, <code>versioning</code>, <code>API.md</code> file and history file <code>_apidoc.js</code>, explanation is within code and generated documentation.</p>
<p>This is a complex example with <code>inherit</code>, <code>versioning</code> file and history file <code>_apidoc.js</code>, explanation is within code and generated documentation.</p>
<p><a href="example/index.html">View example output</a></p>
<p><br/></p>
<p>Files:</p>
<ul>
<li><a href="source/example_full/_apidoc.js">_apidoc.js</a></li>
<li><a href="source/example_full/API.html">API.md</a></li>
<li><a href="source/example_full/example.js">example.js</a></li>
<li><a href="source/example_full/apidoc.json">apidoc.json</a></li>
</ul>
Expand Down Expand Up @@ -1650,4 +1654,4 @@ <h1>MIT License</h1>



</body><!-- Mirrored from apidocjs.com/ by HTTrack Website Copier/3.x [XR&CO'2014], Tue, 06 Oct 2015 07:20:48 GMT --></html>
</body><!-- Mirrored from apidocjs.com/ by HTTrack Website Copier/3.x [XR&CO'2014], Wed, 22 Jun 2016 19:51:57 GMT --></html>
Binary file modified apiDoc.docset/Contents/Resources/docSet.dsidx
View file
Binary file not shown.
4 changes: 2 additions & 2 deletions apiDoc.xml
View file
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<entry>
<version>1.0.1</version>
<url>https://github.com/pfefferle/dash-apidoc/releases/download/1.0.1/apiDoc.tgz</url>
<version>1.0.2</version>
<url>https://github.com/pfefferle/dash-apidoc/releases/download/1.0.2/apiDoc.tgz</url>
</entry>

0 comments on commit f47072a

Please sign in to comment.