Browse Source

docs

pull/1/head
Adrian Salceanu 6 years ago
parent
commit
fe20fe00f6
  1. 175
      doc/Feedlex.Auth.html
  2. 123
      doc/Feedlex.Feed.html
  3. 118
      doc/Feedlex.Request.html
  4. 99
      doc/Feedlex.Response.html
  5. 100
      doc/Feedlex.Stream.html
  6. 100
      doc/Feedlex.Subscription.html
  7. 106
      doc/Feedlex.Util.html
  8. 99
      doc/Feedlex.html
  9. 123
      doc/css/elixir.css
  10. 215
      doc/css/full_list.css
  11. 233
      doc/css/style.css
  12. 45
      doc/exceptions_list.html
  13. 21
      doc/index.html
  14. 7
      doc/js/app.js
  15. 195
      doc/js/full_list.js
  16. 18
      doc/js/highlight.pack.js
  17. 16
      doc/js/jquery.js
  18. 214
      doc/modules_list.html
  19. 107
      doc/overview.html
  20. 45
      doc/protocols_list.html

175
doc/Feedlex.Auth.html

@ -0,0 +1,175 @@
<!DOCTYPE html>
<html>
<head>
<title>Feedlex.Auth</title>
<meta charset="utf-8" />
<link rel="stylesheet" href="css/style.css" type="text/css" media="screen" charset="utf-8" />
<link rel="stylesheet" href="css/elixir.css" type="text/css" media="screen" charset="utf-8" />
<script type="text/javascript" charset="utf-8">
relpath = '';
if (relpath != '') relpath += '/';
</script>
<script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
<script type="text/javascript" charset="utf-8" src="js/app.js"></script>
<script type="text/javascript" charset="utf-8" src="js/highlight.pack.js"></script>
<script type="text/javascript" charset="utf-8">
hljs.initHighlightingOnLoad();
hljs.configure({languages: []}); //disable autodetect
</script>
</head>
<body>
<script type="text/javascript" charset="utf-8">
if (window.top.frames.main) document.body.className = 'frames';
</script>
<section id="content">
<div class="breadcrumbs">feedlex v0.0.1 &rarr; <a href="overview.html">Overview</a> &rarr; <a href="Feedlex.html">Feedlex</a> &rarr; <a href="Feedlex.Auth.html">Auth</a></div>
<h1>
Feedlex.Auth
</h1>
<ul class="summary_links">
<li><a href="#summary">Summary</a></li>
<li><a href="#functions_details">Functions</a></li>
</ul>
<section id="moduledoc" class="docstring">
<p>Exposes authentication and authorization functions into the Feedly API
<a href="https://developer.feedly.com/v3/auth/">https://developer.feedly.com/v3/auth/</a></p>
</section>
<h2 id="summary">Summary<span class="detail_header_links"><a class="to_top_link" href="#content" title="To the top of the page">&uarr;</a></span></h2>
<table class="summary">
<tr>
<td class="summary_signature"><a href="#access_token/1">access_token(opts \\ %{})</a></td>
<td class="summary_synopsis"><p>Exchanges the received Feedly authentication code for a refresh token and
an access token</p>
</td>
</tr>
<tr>
<td class="summary_signature"><a href="#authenticate_uri/1">authenticate_uri(opts \\ %{})</a></td>
<td class="summary_synopsis"><p>Returns the complete URI for beginning the authentication and authorization
process in the browser.
The client should redirect the user to the returned URI</p>
</td>
</tr>
<tr>
<td class="summary_signature"><a href="#refresh_access_token/1">refresh_access_token(opts \\ %{})</a></td>
<td class="summary_synopsis"><p>Uses the refresh token to ask for a new access token</p>
</td>
</tr>
<tr>
<td class="summary_signature"><a href="#revoke_token/1">revoke_token(opts \\ %{})</a></td>
<td class="summary_synopsis"><p>Logoff - revokes the access and refresh tokens</p>
</td>
</tr>
</table>
<section id="functions_details" class="details_list">
<h2>Functions</h2>
<section class="detail">
<div class="detail_header" id="access_token/1">
<span class="signature"><strong>access_token(opts \\ %{})</strong></span>
<div class="detail_header_links">
<span class="detail_type">(function)</span>
<a href="#access_token/1" class="detail_link" title="Link to this function">#</a>
<a class="to_top_link" href="#content" title="To the top of the page">&uarr;</a>
</div>
</div>
<section class="docstring">
<p>Exchanges the received Feedly authentication code for a refresh token and
an access token</p>
</section>
</section>
<section class="detail">
<div class="detail_header" id="authenticate_uri/1">
<span class="signature"><strong>authenticate_uri(opts \\ %{})</strong></span>
<div class="detail_header_links">
<span class="detail_type">(function)</span>
<a href="#authenticate_uri/1" class="detail_link" title="Link to this function">#</a>
<a class="to_top_link" href="#content" title="To the top of the page">&uarr;</a>
</div>
</div>
<section class="docstring">
<p>Returns the complete URI for beginning the authentication and authorization
process in the browser.
The client should redirect the user to the returned URI</p>
</section>
</section>
<section class="detail">
<div class="detail_header" id="refresh_access_token/1">
<span class="signature"><strong>refresh_access_token(opts \\ %{})</strong></span>
<div class="detail_header_links">
<span class="detail_type">(function)</span>
<a href="#refresh_access_token/1" class="detail_link" title="Link to this function">#</a>
<a class="to_top_link" href="#content" title="To the top of the page">&uarr;</a>
</div>
</div>
<section class="docstring">
<p>Uses the refresh token to ask for a new access token</p>
</section>
</section>
<section class="detail">
<div class="detail_header" id="revoke_token/1">
<span class="signature"><strong>revoke_token(opts \\ %{})</strong></span>
<div class="detail_header_links">
<span class="detail_type">(function)</span>
<a href="#revoke_token/1" class="detail_link" title="Link to this function">#</a>
<a class="to_top_link" href="#content" title="To the top of the page">&uarr;</a>
</div>
</div>
<section class="docstring">
<p> Logoff - revokes the access and refresh tokens</p>
</section>
</section>
</section>
</section>
</body>
</html>

123
doc/Feedlex.Feed.html

@ -0,0 +1,123 @@
<!DOCTYPE html>
<html>
<head>
<title>Feedlex.Feed</title>
<meta charset="utf-8" />
<link rel="stylesheet" href="css/style.css" type="text/css" media="screen" charset="utf-8" />
<link rel="stylesheet" href="css/elixir.css" type="text/css" media="screen" charset="utf-8" />
<script type="text/javascript" charset="utf-8">
relpath = '';
if (relpath != '') relpath += '/';
</script>
<script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
<script type="text/javascript" charset="utf-8" src="js/app.js"></script>
<script type="text/javascript" charset="utf-8" src="js/highlight.pack.js"></script>
<script type="text/javascript" charset="utf-8">
hljs.initHighlightingOnLoad();
hljs.configure({languages: []}); //disable autodetect
</script>
</head>
<body>
<script type="text/javascript" charset="utf-8">
if (window.top.frames.main) document.body.className = 'frames';
</script>
<section id="content">
<div class="breadcrumbs">feedlex v0.0.1 &rarr; <a href="overview.html">Overview</a> &rarr; <a href="Feedlex.html">Feedlex</a> &rarr; <a href="Feedlex.Feed.html">Feed</a></div>
<h1>
Feedlex.Feed
</h1>
<ul class="summary_links">
<li><a href="#summary">Summary</a></li>
<li><a href="#functions_details">Functions</a></li>
</ul>
<section id="moduledoc" class="docstring">
<p>Wrapper around the Feedly Feeds API
<a href="https://developer.feedly.com/v3/feeds/">https://developer.feedly.com/v3/feeds/</a></p>
</section>
<h2 id="summary">Summary<span class="detail_header_links"><a class="to_top_link" href="#content" title="To the top of the page">&uarr;</a></span></h2>
<table class="summary">
<tr>
<td class="summary_signature"><a href="#many/1">many(opts \\ %{})</a></td>
<td class="summary_synopsis"><p>Returns meta data for a list of feeds</p>
</td>
</tr>
<tr>
<td class="summary_signature"><a href="#one/1">one(opts \\ %{})</a></td>
<td class="summary_synopsis"><p>Return meta-data about a specific feed</p>
</td>
</tr>
</table>
<section id="functions_details" class="details_list">
<h2>Functions</h2>
<section class="detail">
<div class="detail_header" id="many/1">
<span class="signature"><strong>many(opts \\ %{})</strong></span>
<div class="detail_header_links">
<span class="detail_type">(function)</span>
<a href="#many/1" class="detail_link" title="Link to this function">#</a>
<a class="to_top_link" href="#content" title="To the top of the page">&uarr;</a>
</div>
</div>
<section class="docstring">
<p>Returns meta data for a list of feeds</p>
</section>
</section>
<section class="detail">
<div class="detail_header" id="one/1">
<span class="signature"><strong>one(opts \\ %{})</strong></span>
<div class="detail_header_links">
<span class="detail_type">(function)</span>
<a href="#one/1" class="detail_link" title="Link to this function">#</a>
<a class="to_top_link" href="#content" title="To the top of the page">&uarr;</a>
</div>
</div>
<section class="docstring">
<p>Return meta-data about a specific feed</p>
</section>
</section>
</section>
</section>
</body>
</html>

118
doc/Feedlex.Request.html

@ -0,0 +1,118 @@
<!DOCTYPE html>
<html>
<head>
<title>Feedlex.Request</title>
<meta charset="utf-8" />
<link rel="stylesheet" href="css/style.css" type="text/css" media="screen" charset="utf-8" />
<link rel="stylesheet" href="css/elixir.css" type="text/css" media="screen" charset="utf-8" />
<script type="text/javascript" charset="utf-8">
relpath = '';
if (relpath != '') relpath += '/';
</script>
<script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
<script type="text/javascript" charset="utf-8" src="js/app.js"></script>
<script type="text/javascript" charset="utf-8" src="js/highlight.pack.js"></script>
<script type="text/javascript" charset="utf-8">
hljs.initHighlightingOnLoad();
hljs.configure({languages: []}); //disable autodetect
</script>
</head>
<body>
<script type="text/javascript" charset="utf-8">
if (window.top.frames.main) document.body.className = 'frames';
</script>
<section id="content">
<div class="breadcrumbs">feedlex v0.0.1 &rarr; <a href="overview.html">Overview</a> &rarr; <a href="Feedlex.html">Feedlex</a> &rarr; <a href="Feedlex.Request.html">Request</a></div>
<h1>
Feedlex.Request
</h1>
<ul class="summary_links">
<li><a href="#summary">Summary</a></li>
<li><a href="#functions_details">Functions</a></li>
</ul>
<section id="moduledoc" class="docstring">
<p>Utility module for handling request related functionality</p>
</section>
<h2 id="summary">Summary<span class="detail_header_links"><a class="to_top_link" href="#content" title="To the top of the page">&uarr;</a></span></h2>
<table class="summary">
<tr>
<td class="summary_signature"><a href="#get/1">get(opts \\ %{})</a></td>
<td class="summary_synopsis"><p>Makes a GET request to a feedly API, with header authentication</p>
</td>
</tr>
<tr>
<td class="summary_signature"><a href="#post/1">post(opts \\ %{})</a></td>
</tr>
</table>
<section id="functions_details" class="details_list">
<h2>Functions</h2>
<section class="detail">
<div class="detail_header" id="get/1">
<span class="signature"><strong>get(opts \\ %{})</strong></span>
<div class="detail_header_links">
<span class="detail_type">(function)</span>
<a href="#get/1" class="detail_link" title="Link to this function">#</a>
<a class="to_top_link" href="#content" title="To the top of the page">&uarr;</a>
</div>
</div>
<section class="docstring">
<p>Makes a GET request to a feedly API, with header authentication</p>
</section>
</section>
<section class="detail">
<div class="detail_header" id="post/1">
<span class="signature"><strong>post(opts \\ %{})</strong></span>
<div class="detail_header_links">
<span class="detail_type">(function)</span>
<a href="#post/1" class="detail_link" title="Link to this function">#</a>
<a class="to_top_link" href="#content" title="To the top of the page">&uarr;</a>
</div>
</div>
<section class="docstring">
</section>
</section>
</section>
</section>
</body>
</html>

99
doc/Feedlex.Response.html

@ -0,0 +1,99 @@
<!DOCTYPE html>
<html>
<head>
<title>Feedlex.Response</title>
<meta charset="utf-8" />
<link rel="stylesheet" href="css/style.css" type="text/css" media="screen" charset="utf-8" />
<link rel="stylesheet" href="css/elixir.css" type="text/css" media="screen" charset="utf-8" />
<script type="text/javascript" charset="utf-8">
relpath = '';
if (relpath != '') relpath += '/';
</script>
<script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
<script type="text/javascript" charset="utf-8" src="js/app.js"></script>
<script type="text/javascript" charset="utf-8" src="js/highlight.pack.js"></script>
<script type="text/javascript" charset="utf-8">
hljs.initHighlightingOnLoad();
hljs.configure({languages: []}); //disable autodetect
</script>
</head>
<body>
<script type="text/javascript" charset="utf-8">
if (window.top.frames.main) document.body.className = 'frames';
</script>
<section id="content">
<div class="breadcrumbs">feedlex v0.0.1 &rarr; <a href="overview.html">Overview</a> &rarr; <a href="Feedlex.html">Feedlex</a> &rarr; <a href="Feedlex.Response.html">Response</a></div>
<h1>
Feedlex.Response
</h1>
<ul class="summary_links">
<li><a href="#summary">Summary</a></li>
<li><a href="#functions_details">Functions</a></li>
</ul>
<section id="moduledoc" class="docstring">
<p>Utility functions for dealing with Feedly API responses</p>
</section>
<h2 id="summary">Summary<span class="detail_header_links"><a class="to_top_link" href="#content" title="To the top of the page">&uarr;</a></span></h2>
<table class="summary">
<tr>
<td class="summary_signature"><a href="#parse/1">parse(response)</a></td>
<td class="summary_synopsis"><p>Parses the raw Feedly API response into a common format</p>
</td>
</tr>
</table>
<section id="functions_details" class="details_list">
<h2>Functions</h2>
<section class="detail">
<div class="detail_header" id="parse/1">
<span class="signature"><strong>parse(response)</strong></span>
<div class="detail_header_links">
<span class="detail_type">(function)</span>
<a href="#parse/1" class="detail_link" title="Link to this function">#</a>
<a class="to_top_link" href="#content" title="To the top of the page">&uarr;</a>
</div>
</div>
<section class="docstring">
<p>Parses the raw Feedly API response into a common format</p>
</section>
</section>
</section>
</section>
</body>
</html>

100
doc/Feedlex.Stream.html

@ -0,0 +1,100 @@
<!DOCTYPE html>
<html>
<head>
<title>Feedlex.Stream</title>
<meta charset="utf-8" />
<link rel="stylesheet" href="css/style.css" type="text/css" media="screen" charset="utf-8" />
<link rel="stylesheet" href="css/elixir.css" type="text/css" media="screen" charset="utf-8" />
<script type="text/javascript" charset="utf-8">
relpath = '';
if (relpath != '') relpath += '/';
</script>
<script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
<script type="text/javascript" charset="utf-8" src="js/app.js"></script>
<script type="text/javascript" charset="utf-8" src="js/highlight.pack.js"></script>
<script type="text/javascript" charset="utf-8">
hljs.initHighlightingOnLoad();
hljs.configure({languages: []}); //disable autodetect
</script>
</head>
<body>
<script type="text/javascript" charset="utf-8">
if (window.top.frames.main) document.body.className = 'frames';
</script>
<section id="content">
<div class="breadcrumbs">feedlex v0.0.1 &rarr; <a href="overview.html">Overview</a> &rarr; <a href="Feedlex.html">Feedlex</a> &rarr; <a href="Feedlex.Stream.html">Stream</a></div>
<h1>
Feedlex.Stream
</h1>
<ul class="summary_links">
<li><a href="#summary">Summary</a></li>
<li><a href="#functions_details">Functions</a></li>
</ul>
<section id="moduledoc" class="docstring">
<p>Wrapper around the Feedly Streams API
<a href="https://developer.feedly.com/v3/streams/">https://developer.feedly.com/v3/streams/</a></p>
</section>
<h2 id="summary">Summary<span class="detail_header_links"><a class="to_top_link" href="#content" title="To the top of the page">&uarr;</a></span></h2>
<table class="summary">
<tr>
<td class="summary_signature"><a href="#content/1">content(opts \\ %{})</a></td>
<td class="summary_synopsis"><p>Gets the content of a stream</p>
</td>
</tr>
</table>
<section id="functions_details" class="details_list">
<h2>Functions</h2>
<section class="detail">
<div class="detail_header" id="content/1">
<span class="signature"><strong>content(opts \\ %{})</strong></span>
<div class="detail_header_links">
<span class="detail_type">(function)</span>
<a href="#content/1" class="detail_link" title="Link to this function">#</a>
<a class="to_top_link" href="#content" title="To the top of the page">&uarr;</a>
</div>
</div>
<section class="docstring">
<p>Gets the content of a stream</p>
</section>
</section>
</section>
</section>
</body>
</html>

100
doc/Feedlex.Subscription.html

@ -0,0 +1,100 @@
<!DOCTYPE html>
<html>
<head>
<title>Feedlex.Subscription</title>
<meta charset="utf-8" />
<link rel="stylesheet" href="css/style.css" type="text/css" media="screen" charset="utf-8" />
<link rel="stylesheet" href="css/elixir.css" type="text/css" media="screen" charset="utf-8" />
<script type="text/javascript" charset="utf-8">
relpath = '';
if (relpath != '') relpath += '/';
</script>
<script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
<script type="text/javascript" charset="utf-8" src="js/app.js"></script>
<script type="text/javascript" charset="utf-8" src="js/highlight.pack.js"></script>
<script type="text/javascript" charset="utf-8">
hljs.initHighlightingOnLoad();
hljs.configure({languages: []}); //disable autodetect
</script>
</head>
<body>
<script type="text/javascript" charset="utf-8">
if (window.top.frames.main) document.body.className = 'frames';
</script>
<section id="content">
<div class="breadcrumbs">feedlex v0.0.1 &rarr; <a href="overview.html">Overview</a> &rarr; <a href="Feedlex.html">Feedlex</a> &rarr; <a href="Feedlex.Subscription.html">Subscription</a></div>
<h1>
Feedlex.Subscription
</h1>
<ul class="summary_links">
<li><a href="#summary">Summary</a></li>
<li><a href="#functions_details">Functions</a></li>
</ul>
<section id="moduledoc" class="docstring">
<p>Wrapper around the Feedly Subscriptions API
<a href="https://developer.feedly.com/v3/subscriptions/">https://developer.feedly.com/v3/subscriptions/</a></p>
</section>
<h2 id="summary">Summary<span class="detail_header_links"><a class="to_top_link" href="#content" title="To the top of the page">&uarr;</a></span></h2>
<table class="summary">
<tr>
<td class="summary_signature"><a href="#all/1">all(opts \\ %{})</a></td>
<td class="summary_synopsis"><p>Get all subscriptions</p>
</td>
</tr>
</table>
<section id="functions_details" class="details_list">
<h2>Functions</h2>
<section class="detail">
<div class="detail_header" id="all/1">
<span class="signature"><strong>all(opts \\ %{})</strong></span>
<div class="detail_header_links">
<span class="detail_type">(function)</span>
<a href="#all/1" class="detail_link" title="Link to this function">#</a>
<a class="to_top_link" href="#content" title="To the top of the page">&uarr;</a>
</div>
</div>
<section class="docstring">
<p>Get all subscriptions</p>
</section>
</section>
</section>
</section>
</body>
</html>

106
doc/Feedlex.Util.html

@ -0,0 +1,106 @@
<!DOCTYPE html>
<html>
<head>
<title>Feedlex.Util</title>
<meta charset="utf-8" />
<link rel="stylesheet" href="css/style.css" type="text/css" media="screen" charset="utf-8" />
<link rel="stylesheet" href="css/elixir.css" type="text/css" media="screen" charset="utf-8" />
<script type="text/javascript" charset="utf-8">
relpath = '';
if (relpath != '') relpath += '/';
</script>
<script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
<script type="text/javascript" charset="utf-8" src="js/app.js"></script>
<script type="text/javascript" charset="utf-8" src="js/highlight.pack.js"></script>
<script type="text/javascript" charset="utf-8">
hljs.initHighlightingOnLoad();
hljs.configure({languages: []}); //disable autodetect
</script>
</head>
<body>
<script type="text/javascript" charset="utf-8">
if (window.top.frames.main) document.body.className = 'frames';
</script>
<section id="content">
<div class="breadcrumbs">feedlex v0.0.1 &rarr; <a href="overview.html">Overview</a> &rarr; <a href="Feedlex.html">Feedlex</a> &rarr; <a href="Feedlex.Util.html">Util</a></div>
<h1>
Feedlex.Util
</h1>
<ul class="summary_links">
<li><a href="#summary">Summary</a></li>
<li><a href="#functions_details">Functions</a></li>
</ul>
<section id="moduledoc" class="docstring">
<p>Generic utility functions for Pocketex</p>
</section>
<h2 id="summary">Summary<span class="detail_header_links"><a class="to_top_link" href="#content" title="To the top of the page">&uarr;</a></span></h2>
<table class="summary">
<tr>
<td class="summary_signature"><a href="#underscore_to_bumpy/1">underscore_to_bumpy(string)</a></td>
<td class="summary_synopsis"><p>Converts an option name from Elixir’s underscore_notation to Pocket’s bumpyCase</p>
</td>
</tr>
</table>
<section id="functions_details" class="details_list">
<h2>Functions</h2>
<section class="detail">
<div class="detail_header" id="underscore_to_bumpy/1">
<span class="signature"><strong>underscore_to_bumpy(string)</strong></span>
<div class="detail_header_links">
<span class="detail_type">(function)</span>
<a href="#underscore_to_bumpy/1" class="detail_link" title="Link to this function">#</a>
<a class="to_top_link" href="#content" title="To the top of the page">&uarr;</a>
</div>
</div>
<p>Specs:</p>
<ul class="spec">
<li>underscore_to_bumpy(<a href="http://elixir-lang.org/docs/stable/elixir/String.html#t:t/0">String.t</a>) :: <a href="http://elixir-lang.org/docs/stable/elixir/String.html#t:t/0">String.t</a></li>
</ul>
<section class="docstring">
<p>Converts an option name from Elixir’s underscore_notation to Pocket’s bumpyCase</p>
</section>
</section>
</section>
</section>
</body>
</html>

99
doc/Feedlex.html

@ -0,0 +1,99 @@
<!DOCTYPE html>
<html>
<head>
<title>Feedlex</title>
<meta charset="utf-8" />
<link rel="stylesheet" href="css/style.css" type="text/css" media="screen" charset="utf-8" />
<link rel="stylesheet" href="css/elixir.css" type="text/css" media="screen" charset="utf-8" />
<script type="text/javascript" charset="utf-8">
relpath = '';
if (relpath != '') relpath += '/';
</script>
<script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
<script type="text/javascript" charset="utf-8" src="js/app.js"></script>
<script type="text/javascript" charset="utf-8" src="js/highlight.pack.js"></script>
<script type="text/javascript" charset="utf-8">
hljs.initHighlightingOnLoad();
hljs.configure({languages: []}); //disable autodetect
</script>
</head>
<body>
<script type="text/javascript" charset="utf-8">
if (window.top.frames.main) document.body.className = 'frames';
</script>
<section id="content">
<div class="breadcrumbs">feedlex v0.0.1 &rarr; <a href="overview.html">Overview</a> &rarr; <a href="Feedlex.html">Feedlex</a></div>
<h1>
Feedlex
</h1>
<ul class="summary_links">
<li><a href="#summary">Summary</a></li>
<li><a href="#functions_details">Functions</a></li>
</ul>
<section id="moduledoc" class="docstring">
<p>Wrapper around the Feedly API</p>
</section>
<h2 id="summary">Summary<span class="detail_header_links"><a class="to_top_link" href="#content" title="To the top of the page">&uarr;</a></span></h2>
<table class="summary">
<tr>
<td class="summary_signature"><a href="#feedly_api_host/0">feedly_api_host()</a></td>
<td class="summary_synopsis"><p>Getter for accessing the feedly_api_host config</p>
</td>
</tr>
</table>
<section id="functions_details" class="details_list">
<h2>Functions</h2>
<section class="detail">
<div class="detail_header" id="feedly_api_host/0">
<span class="signature"><strong>feedly_api_host()</strong></span>
<div class="detail_header_links">
<span class="detail_type">(function)</span>
<a href="#feedly_api_host/0" class="detail_link" title="Link to this function">#</a>
<a class="to_top_link" href="#content" title="To the top of the page">&uarr;</a>
</div>
</div>
<section class="docstring">
<p>Getter for accessing the feedly_api_host config</p>
</section>
</section>
</section>
</section>
</body>
</html>

123
doc/css/elixir.css

@ -0,0 +1,123 @@
/*
github.com style (c) Vasily Polovnyov <vast@whiteants.net>
*/
.hljs {
overflow-x: auto;
color: #333;
padding: 0.5em;
border: #ffe0bb dotted 1px;
background: #fffde8;
display: block;
-webkit-text-size-adjust: none;
}
.hljs-comment,
.diff .hljs-header,
.hljs-javadoc {
color: #998;
font-style: italic;
}
.hljs-keyword,
.css .rule .hljs-keyword,
.hljs-winutils,
.nginx .hljs-title,
.hljs-subst,
.hljs-request,
.hljs-status {
color: #333;
font-weight: bold;
}
.hljs-number,
.hljs-hexcolor,
.ruby .hljs-constant {
color: #008080;
}
.hljs-string,
.hljs-tag .hljs-value,
.hljs-phpdoc,
.hljs-dartdoc,
.tex .hljs-formula {
color: #d14;
}
.hljs-title,
.hljs-id,
.scss .hljs-preprocessor {
color: #900;
font-weight: bold;
}
.hljs-list .hljs-keyword,
.hljs-subst {
font-weight: normal;
}
.hljs-class .hljs-title,
.hljs-type,
.vhdl .hljs-literal,
.tex .hljs-command {
color: #445588;
font-weight: bold;
}
.hljs-tag,
.hljs-tag .hljs-title,
.hljs-rules .hljs-property,
.django .hljs-tag .hljs-keyword {
color: #000080;
font-weight: normal;
}
.hljs-attribute,
.hljs-variable,
.lisp .hljs-body {
color: #008080;
}
.hljs-regexp {
color: #009926;
}
.hljs-symbol,
.ruby .hljs-symbol .hljs-string,
.lisp .hljs-keyword,
.clojure .hljs-keyword,
.scheme .hljs-keyword,
.tex .hljs-special,
.hljs-prompt {
color: #990073;
}
.hljs-built_in {
color: #0086b3;
}
.hljs-preprocessor,
.hljs-pragma,
.hljs-pi,
.hljs-doctype,
.hljs-shebang,
.hljs-cdata {
color: #999;
font-weight: bold;
}
.hljs-deletion {
background: #fdd;
}
.hljs-addition {
background: #dfd;
}
.diff .hljs-change {
background: #0086b3;
}
.hljs-chunk {
color: #aaa;
}

215
doc/css/full_list.css

@ -0,0 +1,215 @@
/*** DOCUMENT STRUCTURE: list_template.eex ***
body.frames
section#content [.in_search]
h1#full_list_header
h2#sub_list_header
div#nav
div#search [.loading] > input#search_field
ul#full_list
li.node [.collpased, .search_uncollapsed, .found]
a.toggle
a.object_link
span.node_name
li.docs [.collpased, .search_uncollapsed, .found]
a.toggle
a.object_link
span.node_name
...
div.no_results
*/
/* DOCUMENT STYLES */
body {
font: 13px "Lucida Sans", "Lucida Grande", Verdana, Arial, sans-serif;
height: 101%;
margin: 0;
overflow-x: hidden;
}
h1 {
font-size: 1.4em;
margin: 0;
padding: 12px 10px 0;
}
a:link, a:visited {
color: #05a;
text-decoration: none;
}
li {
color: #888;
cursor: pointer;
}
li:hover {
background: #ddd;
}
span.node_name {
font-size: 0.8em;
}
/*** LEFT FRAME ***/
.frames li {
white-space: nowrap;
cursor: default;
}
/* HEADERS */
.frames h1 {
margin-top: 0;
}
.frames h2 {
font-size: 0.9em;
margin: 5px 10px 15px;
}
/* NAVIGATION BAR */
.nav {
margin: 0 0 10px 5px;
font-size: 0.9em;
color: #aaa;
}
.nav a:link,
.nav a:visited {
color: #358;
}
.nav a:hover {
background: transparent;
color: #5af;
}
.nav span {
border-left: 1px solid #ccc;
padding: 0 3px 0 5px;
}
.nav span:first-child {
border-left: 0;
border-radius: 3px;
}
.nav span.selected {
text-decoration: underline;
}
/* SEARCH BOX */
#search {
font-size: 0.9em;
color: #888;
margin: 3px; margin-left: 10px;
padding-left: 0; padding-right: 24px;
}
#search_field {
width: 180px;
margin-right:35px;
border:2px solid #d8d8e5;
padding:2px 4px;
-moz-box-sizing: border-box;
}
#search.loading {
background: url(data:image/gif;base64,R0lGODlhEAAQAPYAAP///wAAAPr6+pKSkoiIiO7u7sjIyNjY2J6engAAAI6OjsbGxjIyMlJSUuzs7KamppSUlPLy8oKCghwcHLKysqSkpJqamvT09Pj4+KioqM7OzkRERAwMDGBgYN7e3ujo6Ly8vCoqKjY2NkZGRtTU1MTExDw8PE5OTj4+PkhISNDQ0MrKylpaWrS0tOrq6nBwcKysrLi4uLq6ul5eXlxcXGJiYoaGhuDg4H5+fvz8/KKiohgYGCwsLFZWVgQEBFBQUMzMzDg4OFhYWBoaGvDw8NbW1pycnOLi4ubm5kBAQKqqqiQkJCAgIK6urnJyckpKSjQ0NGpqatLS0sDAwCYmJnx8fEJCQlRUVAoKCggICLCwsOTk5ExMTPb29ra2tmZmZmhoaNzc3KCgoBISEiIiIgAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAACH/C05FVFNDQVBFMi4wAwEAAAAh/hpDcmVhdGVkIHdpdGggYWpheGxvYWQuaW5mbwAh+QQJCAAAACwAAAAAEAAQAAAHaIAAgoMgIiYlg4kACxIaACEJCSiKggYMCRselwkpghGJBJEcFgsjJyoAGBmfggcNEx0flBiKDhQFlIoCCA+5lAORFb4AJIihCRbDxQAFChAXw9HSqb60iREZ1omqrIPdJCTe0SWI09GBACH5BAkIAAAALAAAAAAQABAAAAdrgACCgwc0NTeDiYozCQkvOTo9GTmDKy8aFy+NOBA7CTswgywJDTIuEjYFIY0JNYMtKTEFiRU8Pjwygy4ws4owPyCKwsMAJSTEgiQlgsbIAMrO0dKDGMTViREZ14kYGRGK38nHguHEJcvTyIEAIfkECQgAAAAsAAAAABAAEAAAB2iAAIKDAggPg4iJAAMJCRUAJRIqiRGCBI0WQEEJJkWDERkYAAUKEBc4Po1GiKKJHkJDNEeKig4URLS0ICImJZAkuQAhjSi/wQyNKcGDCyMnk8u5rYrTgqDVghgZlYjcACTA1sslvtHRgQAh+QQJCAAAACwAAAAAEAAQAAAHZ4AAgoOEhYaCJSWHgxGDJCQARAtOUoQRGRiFD0kJUYWZhUhKT1OLhR8wBaaFBzQ1NwAlkIszCQkvsbOHL7Y4q4IuEjaqq0ZQD5+GEEsJTDCMmIUhtgk1lo6QFUwJVDKLiYJNUd6/hoEAIfkECQgAAAAsAAAAABAAEAAAB2iAAIKDhIWGgiUlh4MRgyQkjIURGRiGGBmNhJWHm4uen4ICCA+IkIsDCQkVACWmhwSpFqAABQoQF6ALTkWFnYMrVlhWvIKTlSAiJiVVPqlGhJkhqShHV1lCW4cMqSkAR1ofiwsjJyqGgQAh+QQJCAAAACwAAAAAEAAQAAAHZ4AAgoOEhYaCJSWHgxGDJCSMhREZGIYYGY2ElYebi56fhyWQniSKAKKfpaCLFlAPhl0gXYNGEwkhGYREUywag1wJwSkHNDU3D0kJYIMZQwk8MjPBLx9eXwuETVEyAC/BOKsuEjYFhoEAIfkECQgAAAAsAAAAABAAEAAAB2eAAIKDhIWGgiUlh4MRgyQkjIURGRiGGBmNhJWHm4ueICImip6CIQkJKJ4kigynKaqKCyMnKqSEK05StgAGQRxPYZaENqccFgIID4KXmQBhXFkzDgOnFYLNgltaSAAEpxa7BQoQF4aBACH5BAkIAAAALAAAAAAQABAAAAdogACCg4SFggJiPUqCJSWGgkZjCUwZACQkgxGEXAmdT4UYGZqCGWQ+IjKGGIUwPzGPhAc0NTewhDOdL7Ykji+dOLuOLhI2BbaFETICx4MlQitdqoUsCQ2vhKGjglNfU0SWmILaj43M5oEAOwAAAAAAAAAAAA==) no-repeat 188px center;
min-height:18px;
}
#content #no_results {
margin-left: 7px;
padding: 7px 12px;
}
/* FULL LIST OF CONTENTS */
#full_list {
list-style: none;
margin-left: 0;
padding: 0;
}
#full_list ul {
margin:0;
padding: 0;
}
#full_list li {
margin: 0;
padding: 5px 5px 5px 0;
font-size: 1.1em;
list-style: none;
}
#full_list li.node {
padding-left: 25px;
}
#full_list li.docs {
padding:0;
}
#full_list li.docs li {
padding-left: 25px;
}
#full_list li span.node_name {
display: none;
}
#full_list .no_padding {
padding-left:0;
}
/* while searching */
.in_search #full_list ul {
margin-left:0;}
.in_search #full_list li {
display: none;
}
.in_search #full_list li.found {
display: list-item;
}
.in_search #full_list li a.toggle {
display: none;
}
.in_search #full_list li span.node_name {
display: block;
}
/* collapsed menu */
#full_list .search_uncollapsed,
#full_list .search_uncollapsed ul {
display:block !important;
}
#full_list ul.collapsed ul,
#full_list ul.collapsed li,
#full_list li.collapsed ul,
#full_list li.collapsed li {
display: none;
}
#full_list ul.search_uncollapsed li.found,
#full_list li.search_uncollapsed li.found {
display: list-item;
}
li.deprecated {
text-decoration: line-through;
font-style: italic;
}
li.r1 {
background: #f0f0f0;
}
li.r2 {
background: #fafafa;
}
/* link properties */
li a.toggle {
display: block;
float: left;
position: relative;
left: -5px;
top: 4px;
width: 10px;
height: 9px;
margin-left: -10px;
text-indent: -999px;
background: url(data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABQAAAASCAYAAABb0P4QAAAABHNCSVQICAgIfAhkiAAAAAlwSFlzAAAK8AAACvABQqw0mAAAABx0RVh0U29mdHdhcmUAQWRvYmUgRmlyZXdvcmtzIENTM5jWRgMAAAAVdEVYdENyZWF0aW9uIFRpbWUAMy8xNC8wOeNZPpQAAAE2SURBVDiNrZTBccIwEEXfelIAHUA6CZ24BGaWO+FuzZAK4k6gg5QAdGAq+Bxs2Yqx7BzyL7Llp/VfzZeQhCTc/ezuGzKKnKSzpCxXJM8fwNXda3df5RZETlIt6YUzSQDs93sl8w3wBZxCCE10GM1OcWbWjB2mWgEH4Mfdyxm3PSepBHibgQE2wLe7r4HjEidpnXMYdQPKEMJcsZ4zs2POYQOcaPfwMVOo58zsAdMt18BuoVDPxUJRacELbXv3hUIX2vYmOUvi8C8ydz/ThjXrqKqqLbDIAdsCKBd+Wo7GWa7o9qzOQHVVVXeAbs+yHHCH4aTsaCOQqunmUy1yBUAXkdMIfMlgF5EXLo2OpV/c/Up7jG4hhHcYLgWzAZXUc2b2ixsfvc/RmNNfOXD3Q/oeL9axJE1yT9IOoUu6MGUkAAAAAElFTkSuQmCC) no-repeat bottom left;
cursor: default;
}
li.collapsed a.toggle {
opacity: 0.5;
cursor: default;
background-position: top left;
}
li.clicked {
background: #05a;
color: #ccc;
}
li.clicked a:link, li.clicked a:visited {
color: #eee;
}
li.clicked a.toggle {
opacity: 0.5;
background-position: bottom right;
}
li.collapsed.clicked a.toggle {
background-position: top right;
}

233
doc/css/style.css

@ -0,0 +1,233 @@
/*** DOCUMENT STRUCTURE: module_template.eex ***
body
section#content
div.breadcrumbs
h1
small
ul.summary_links
li > a
...
section.docstring#moduledoc
a.view_source
h2#summary > span.detail_header_links > a.to_top_link
table.summary
tr
td.summary_signature > a
td.summary_synopsis > p
...
section.details_list#types_details
h2 > a.to_top_link
div.type_detail
p.typespec > a
...
section.details_list#functions_details
h2
section.detail
div.detail_header
span.signature > strong
div.detail_header_links
span.detail_type
a.detail_link
a.to_top_link
ul.spec
li > a
...
section.docstring
a.view_source
...
*/
/* DOCUMENT STYLES */
body {
font: 13px "Lucida Sans", "Lucida Grande", Verdana, Arial, sans-serif;
padding: 0 20px;
}
a:link,
a:visited {
color: #05a;
text-decoration: none;
}
a:hover {
color: #27c;
}
h1 {
font-size: 25px;
border-top: 0;
margin-top: 0;
padding-top: 4px;
}
h1 small {
color: #888;
font-size: 18px;
}
h2 {
padding: 0;
padding-bottom: 3px;
border-bottom: 1px #aaa solid;
font-size: 1.4em;
margin: 1.8em 0 0.5em;
}
.clear {
clear: both;
}
table {
border: 1px solid #aaa;
border-collapse: collapse;
margin-top: 1em;
}
table th {
background: #fafafa;
}
table th,
table td {
border: 1px solid #ddd;
padding: 0.4em 1em 0.4em 0.4em;
}
table tr:nth-child(odd) {
background: #f0f0f0;
}
table tr:nth-child(even) {
background: #fafafa;
}
/* OTHERS */
body.frames {
padding: 0 5px;
}
li.r1 {
background: #f0f0f0;
}
li.r2 {
background: #fafafa;
}
div.breadcrumbs {
padding-bottom: 0.5em;
}
/* SUMMARY LINKS */
ul.summary_links {
margin: 0 0 1em 0;
padding: 0em;
}
ul.summary_links li {
display: inline-block;
list-style-type: none;
width: 7em;
text-align: center;
background: #f0f0f0;
}
/* DOCSTRING */
section.docstring,
p.docstring {
margin-right: 6em;
}
.docstring h1,
.docstring h2,
.docstring h3,
.docstring h4 {
padding: 0;
border: 0;
}
.docstring h1 {
font-size: 1.3em;
}
.docstring h2 {
font-size: 1.2em;
}
.docstring h3,
.docstring h4 {
font-size: 1em;
padding-top: 10px;
}
.docstring ul {
padding-left: 20px;
}
.docstring li > p {
margin: 0;
}
/* SUMMARY */
div.detail_header_links {
float: right;
}
a.to_top_link {
padding-left: 0.3em;
font-size: 1em;
font-weight: normal;
}
table.summary {
border: 0;
border-collapse: separate;
}
table.summary tr:nth-child(odd) {
background: #f0f0f0;
}
table.summary tr:nth-child(even) {
background: #fafafa;
}
table.summary tr td {
border: 0;
padding-top: 0.5em; padding-bottom: 0.5em;
}
td.summary_signature {
padding-right: 0.5em;
}
td.summary_synopsis {
padding-left: 0.5em;
}
td.summary_synopsis p {
margin: 0;
}
/* DETAILS LIST */
.spec, .typespec {
font: bold 1em Courier, monospace;
}
ul.spec {
padding: 6px 10px 6px 25px;
list-style-type: none;
}
.type_detail {
margin-top: 15px;
padding-top: 0;
}
.type_detail > div.typespec_doc {
margin-left: 3em;
}
.detail {
border-top: 1px dotted #aaa;
margin-top: 15px;
padding-top: 0;
}
.detail:nth-child(2) {
border: 0;
}
div.detail_header {
background: #e5e8ff;
border: 1px solid #d8d8e5;
border-radius: 3px;
margin-top: 18px;
padding: 6px 10px;
}
span.signature {
font: normal 1.1em Monaco, Consolas, Courier, monospace;
}
span.detail_type {
font-style: italic;
font-size: 0.9em;
}
a.detail_link {
padding-left: 0.3em;
}

45
doc/exceptions_list.html

@ -0,0 +1,45 @@
<!DOCTYPE html>
<html>
<head>
<title>List of Exceptions</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<link rel="stylesheet" href="css/full_list.css" type="text/css" media="screen" charset="utf-8" />
<script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
<script type="text/javascript" charset="utf-8" src="js/full_list.js"></script>
<base id="base_target" target="_parent" />
</head>
<body class="frames">
<script type="text/javascript" charset="utf-8">
if (window.top.frames.main) {
document.getElementById('base_target').target = 'main';
document.body.className = 'frames';
}
</script>
<section id="content">
<h1 id="full_list_header">
feedlex v0.0.1
</h1>
<h2 id="sub_list_header">
<a href="overview.html">Overview</a>
</h2>
<div class="nav">
<span class=""><a target="_self" href="modules_list.html">Modules</a></span>
<span class="selected"><a target="_self" href="exceptions_list.html">Exceptions</a></span>
<span class=""><a target="_self" href="protocols_list.html">Protocols</a></span>
</div>
<div id="search"><input type="search" id="search_field" placeholder="Search" autocomplete="off" autofocus="autofocus" results="0" /></div>
<ul id="full_list">
</ul>
<div id="no_results"></div>
</section>
</body>
</html>

21
doc/index.html

@ -0,0 +1,21 @@
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
<title>feedlex v0.0.1 Documentation</title>
<script type="text/javascript" charset="utf-8">
window.onload = function frame_redirect() {
if ( window.location.href.match(/\/#!/, window.location.hash) ) {
document.querySelector('#main').src = window.location.href.replace(/\/#!/, '/');
} else if ( window.location.href.match(/\/index.html#!/, window.location.hash) ) {
document.querySelector('#main').src = window.location.href.replace(/\/index.html#!/, '/');
}
}
</script>
</head>
<frameset cols="20%,*">
<frame name="list" id="list" src="modules_list.html" />
<frame name="main" id="main" src="overview.html" />
</frameset>
</html>

7
doc/js/app.js

@ -0,0 +1,7 @@
function fixOutsideWorldLinks() {
$('a').each(function() {
if (window.location.host != this.host) this.target = '_parent';
});
}
$(fixOutsideWorldLinks);

195
doc/js/full_list.js

@ -0,0 +1,195 @@
var inSearch = null;
var defaultSearchItemTimeOut = 0; //set to "0" if not testing
var searchIndex = 0;
var searchCache = [];
var searchString = '';
var regexSearchString = '';
var caseSensitiveMatch = false;