Skip to content

Commit

Permalink
move docs to doc/, otherwise edoc won't pick up overview.edoc
Browse files Browse the repository at this point in the history
  • Loading branch information
deadtrickster committed Sep 17, 2016
1 parent 0883961 commit c5c8ba6
Show file tree
Hide file tree
Showing 48 changed files with 46 additions and 46 deletions.
File renamed without changes.
File renamed without changes.
File renamed without changes
File renamed without changes.
File renamed without changes.
2 changes: 1 addition & 1 deletion docs/overview-summary.html → doc/overview-summary.html
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,6 @@ <h1>The prometheus application</h1>

<hr>
<div class="navbar"><a name="#navbar_bottom"></a><table width="100%" border="0" cellspacing="0" cellpadding="2" summary="navigation bar"><tr><td><a href="overview-summary.html" target="overviewFrame">Overview</a></td><td><a href="http://www.erlang.org/"><img src="erlang.png" align="right" border="0" alt="erlang logo"></a></td></tr></table></div>
<p><i>Generated by EDoc, Sep 14 2016, 00:01:40.</i></p>
<p><i>Generated by EDoc, Sep 14 2016, 19:19:13.</i></p>
</body>
</html>
Empty file added doc/overview.edoc
Empty file.
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,6 @@ <h3 class="function"><a name="linear-3">linear/3</a></h3>
<hr>

<div class="navbar"><a name="#navbar_bottom"></a><table width="100%" border="0" cellspacing="0" cellpadding="2" summary="navigation bar"><tr><td><a href="overview-summary.html" target="overviewFrame">Overview</a></td><td><a href="http://www.erlang.org/"><img src="erlang.png" align="right" border="0" alt="erlang logo"></a></td></tr></table></div>
<p><i>Generated by EDoc, Sep 14 2016, 00:01:40.</i></p>
<p><i>Generated by EDoc, Sep 14 2016, 19:19:13.</i></p>
</body>
</html>
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -103,6 +103,6 @@ <h3 class="function"><a name="register-2">register/2</a></h3>
<hr>

<div class="navbar"><a name="#navbar_bottom"></a><table width="100%" border="0" cellspacing="0" cellpadding="2" summary="navigation bar"><tr><td><a href="overview-summary.html" target="overviewFrame">Overview</a></td><td><a href="http://www.erlang.org/"><img src="erlang.png" align="right" border="0" alt="erlang logo"></a></td></tr></table></div>
<p><i>Generated by EDoc, Sep 14 2016, 00:01:40.</i></p>
<p><i>Generated by EDoc, Sep 14 2016, 19:19:13.</i></p>
</body>
</html>
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -194,6 +194,6 @@ <h3 class="function"><a name="value-3">value/3</a></h3>
<hr>

<div class="navbar"><a name="#navbar_bottom"></a><table width="100%" border="0" cellspacing="0" cellpadding="2" summary="navigation bar"><tr><td><a href="overview-summary.html" target="overviewFrame">Overview</a></td><td><a href="http://www.erlang.org/"><img src="erlang.png" align="right" border="0" alt="erlang logo"></a></td></tr></table></div>
<p><i>Generated by EDoc, Sep 14 2016, 00:01:39.</i></p>
<p><i>Generated by EDoc, Sep 14 2016, 19:19:13.</i></p>
</body>
</html>
File renamed without changes.
2 changes: 1 addition & 1 deletion docs/prometheus_format.html → doc/prometheus_format.html
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,6 @@ <h1>Module prometheus_format</h1>
<hr>

<div class="navbar"><a name="#navbar_bottom"></a><table width="100%" border="0" cellspacing="0" cellpadding="2" summary="navigation bar"><tr><td><a href="overview-summary.html" target="overviewFrame">Overview</a></td><td><a href="http://www.erlang.org/"><img src="erlang.png" align="right" border="0" alt="erlang logo"></a></td></tr></table></div>
<p><i>Generated by EDoc, Sep 14 2016, 00:01:40.</i></p>
<p><i>Generated by EDoc, Sep 14 2016, 19:19:13.</i></p>
</body>
</html>
File renamed without changes.
2 changes: 1 addition & 1 deletion docs/prometheus_gauge.html → doc/prometheus_gauge.html
Original file line number Diff line number Diff line change
Expand Up @@ -342,6 +342,6 @@ <h3 class="function"><a name="value-3">value/3</a></h3>
<hr>

<div class="navbar"><a name="#navbar_bottom"></a><table width="100%" border="0" cellspacing="0" cellpadding="2" summary="navigation bar"><tr><td><a href="overview-summary.html" target="overviewFrame">Overview</a></td><td><a href="http://www.erlang.org/"><img src="erlang.png" align="right" border="0" alt="erlang logo"></a></td></tr></table></div>
<p><i>Generated by EDoc, Sep 14 2016, 00:01:39.</i></p>
<p><i>Generated by EDoc, Sep 14 2016, 19:19:13.</i></p>
</body>
</html>
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -231,6 +231,6 @@ <h3 class="function"><a name="value-3">value/3</a></h3>
<hr>

<div class="navbar"><a name="#navbar_bottom"></a><table width="100%" border="0" cellspacing="0" cellpadding="2" summary="navigation bar"><tr><td><a href="overview-summary.html" target="overviewFrame">Overview</a></td><td><a href="http://www.erlang.org/"><img src="erlang.png" align="right" border="0" alt="erlang logo"></a></td></tr></table></div>
<p><i>Generated by EDoc, Sep 14 2016, 00:01:39.</i></p>
<p><i>Generated by EDoc, Sep 14 2016, 19:19:13.</i></p>
</body>
</html>
File renamed without changes.
2 changes: 1 addition & 1 deletion docs/prometheus_http.html → doc/prometheus_http.html
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,6 @@ <h3 class="function"><a name="status_class-1">status_class/1</a></h3>
<hr>

<div class="navbar"><a name="#navbar_bottom"></a><table width="100%" border="0" cellspacing="0" cellpadding="2" summary="navigation bar"><tr><td><a href="overview-summary.html" target="overviewFrame">Overview</a></td><td><a href="http://www.erlang.org/"><img src="erlang.png" align="right" border="0" alt="erlang logo"></a></td></tr></table></div>
<p><i>Generated by EDoc, Sep 14 2016, 00:01:39.</i></p>
<p><i>Generated by EDoc, Sep 14 2016, 19:19:13.</i></p>
</body>
</html>
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,6 @@ <h3 class="function"><a name="setup-1">setup/1</a></h3>
<hr>

<div class="navbar"><a name="#navbar_bottom"></a><table width="100%" border="0" cellspacing="0" cellpadding="2" summary="navigation bar"><tr><td><a href="overview-summary.html" target="overviewFrame">Overview</a></td><td><a href="http://www.erlang.org/"><img src="erlang.png" align="right" border="0" alt="erlang logo"></a></td></tr></table></div>
<p><i>Generated by EDoc, Sep 14 2016, 00:01:40.</i></p>
<p><i>Generated by EDoc, Sep 14 2016, 19:19:13.</i></p>
</body>
</html>
File renamed without changes.
2 changes: 1 addition & 1 deletion docs/prometheus_metric.html → doc/prometheus_metric.html
Original file line number Diff line number Diff line change
Expand Up @@ -78,6 +78,6 @@ <h3 class="function"><a name="remove_labels-4">remove_labels/4</a></h3>
<hr>

<div class="navbar"><a name="#navbar_bottom"></a><table width="100%" border="0" cellspacing="0" cellpadding="2" summary="navigation bar"><tr><td><a href="overview-summary.html" target="overviewFrame">Overview</a></td><td><a href="http://www.erlang.org/"><img src="erlang.png" align="right" border="0" alt="erlang logo"></a></td></tr></table></div>
<p><i>Generated by EDoc, Sep 14 2016, 00:01:40.</i></p>
<p><i>Generated by EDoc, Sep 14 2016, 19:19:13.</i></p>
</body>
</html>
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,6 @@ <h3 class="typedecl"><a name="type-spec">spec()</a></h3>
<hr>

<div class="navbar"><a name="#navbar_bottom"></a><table width="100%" border="0" cellspacing="0" cellpadding="2" summary="navigation bar"><tr><td><a href="overview-summary.html" target="overviewFrame">Overview</a></td><td><a href="http://www.erlang.org/"><img src="erlang.png" align="right" border="0" alt="erlang logo"></a></td></tr></table></div>
<p><i>Generated by EDoc, Sep 14 2016, 00:01:40.</i></p>
<p><i>Generated by EDoc, Sep 14 2016, 19:19:13.</i></p>
</body>
</html>
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -202,6 +202,6 @@ <h3 class="function"><a name="untyped_metrics-1">untyped_metrics/1</a></h3>
<hr>

<div class="navbar"><a name="#navbar_bottom"></a><table width="100%" border="0" cellspacing="0" cellpadding="2" summary="navigation bar"><tr><td><a href="overview-summary.html" target="overviewFrame">Overview</a></td><td><a href="http://www.erlang.org/"><img src="erlang.png" align="right" border="0" alt="erlang logo"></a></td></tr></table></div>
<p><i>Generated by EDoc, Sep 14 2016, 00:01:40.</i></p>
<p><i>Generated by EDoc, Sep 14 2016, 19:19:13.</i></p>
</body>
</html>
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,6 @@ <h3 class="function"><a name="format-1">format/1</a></h3>
<hr>

<div class="navbar"><a name="#navbar_bottom"></a><table width="100%" border="0" cellspacing="0" cellpadding="2" summary="navigation bar"><tr><td><a href="overview-summary.html" target="overviewFrame">Overview</a></td><td><a href="http://www.erlang.org/"><img src="erlang.png" align="right" border="0" alt="erlang logo"></a></td></tr></table></div>
<p><i>Generated by EDoc, Sep 14 2016, 00:01:40.</i></p>
<p><i>Generated by EDoc, Sep 14 2016, 19:19:13.</i></p>
</body>
</html>
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -125,6 +125,6 @@ <h3 class="function"><a name="register_collectors-2">register_collectors/2</a></
<hr>

<div class="navbar"><a name="#navbar_bottom"></a><table width="100%" border="0" cellspacing="0" cellpadding="2" summary="navigation bar"><tr><td><a href="overview-summary.html" target="overviewFrame">Overview</a></td><td><a href="http://www.erlang.org/"><img src="erlang.png" align="right" border="0" alt="erlang logo"></a></td></tr></table></div>
<p><i>Generated by EDoc, Sep 14 2016, 00:01:40.</i></p>
<p><i>Generated by EDoc, Sep 14 2016, 19:19:13.</i></p>
</body>
</html>
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -190,6 +190,6 @@ <h3 class="function"><a name="value-3">value/3</a></h3>
<hr>

<div class="navbar"><a name="#navbar_bottom"></a><table width="100%" border="0" cellspacing="0" cellpadding="2" summary="navigation bar"><tr><td><a href="overview-summary.html" target="overviewFrame">Overview</a></td><td><a href="http://www.erlang.org/"><img src="erlang.png" align="right" border="0" alt="erlang logo"></a></td></tr></table></div>
<p><i>Generated by EDoc, Sep 14 2016, 00:01:39.</i></p>
<p><i>Generated by EDoc, Sep 14 2016, 19:19:13.</i></p>
</body>
</html>
File renamed without changes.
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -76,6 +76,6 @@ <h3 class="function"><a name="format-1">format/1</a></h3>
<hr>

<div class="navbar"><a name="#navbar_bottom"></a><table width="100%" border="0" cellspacing="0" cellpadding="2" summary="navigation bar"><tr><td><a href="overview-summary.html" target="overviewFrame">Overview</a></td><td><a href="http://www.erlang.org/"><img src="erlang.png" align="right" border="0" alt="erlang logo"></a></td></tr></table></div>
<p><i>Generated by EDoc, Sep 14 2016, 00:01:40.</i></p>
<p><i>Generated by EDoc, Sep 14 2016, 19:19:13.</i></p>
</body>
</html>
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -12,17 +12,17 @@
<h1>Module prometheus_vm_memory_collector</h1>
<ul class="index"><li><a href="#description">Description</a></li></ul>
Collects information about memory dynamically allocated
by the Erlang emulator usin
<a href="http://erlang.org/doc/man/erlang.html#statistics-1">
by the Erlang emulator using
<a href="http://erlang.org/doc/man/erlang.html#memory-0">
erlang:memory/0
</a>.

<p><b>Behaviours:</b> <a href="prometheus_collector.html"><tt>prometheus_collector</tt></a>.</p>

<h2><a name="description">Description</a></h2><p>
Collects information about memory dynamically allocated
by the Erlang emulator usin
<a href="http://erlang.org/doc/man/erlang.html#statistics-1">
by the Erlang emulator using
<a href="http://erlang.org/doc/man/erlang.html#memory-0">
erlang:memory/0
</a>. Also provides basic (D)ETS statistics.</p>

Expand Down Expand Up @@ -80,6 +80,6 @@ <h3><a name="Exported_metrics">Exported metrics</a></h3>
<hr>

<div class="navbar"><a name="#navbar_bottom"></a><table width="100%" border="0" cellspacing="0" cellpadding="2" summary="navigation bar"><tr><td><a href="overview-summary.html" target="overviewFrame">Overview</a></td><td><a href="http://www.erlang.org/"><img src="erlang.png" align="right" border="0" alt="erlang logo"></a></td></tr></table></div>
<p><i>Generated by EDoc, Sep 14 2016, 00:01:40.</i></p>
<p><i>Generated by EDoc, Sep 14 2016, 19:19:13.</i></p>
</body>
</html>
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,10 @@
* [Description](#description)

Collects information about memory dynamically allocated
by the Erlang emulator usin
by the Erlang emulator using
[
erlang:memory/0
](http://erlang.org/doc/man/erlang.md#statistics-1).
](http://erlang.org/doc/man/erlang.md#memory-0).

__Behaviours:__ [`prometheus_collector`](prometheus_collector.md).

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -78,25 +78,25 @@ <h3><a name="Configuration">Configuration</a></h3>
</a>:
<ul>
<li>
<code>context_switches</code> for <code>erlang_vm_statistics_context_switches</code>.
<code>context_switches</code> for <code>erlang_vm_statistics_context_switches</code>;
</li>
<li>
<code>garbage_collection</code>
for <code>erlang_vm_statistics_garbage_collection_number_of_gcs</code> and
<code>erlang_vm_statistics_garbage_collection_words_reclaimed</code>.
<code>erlang_vm_statistics_garbage_collection_words_reclaimed</code>;
</li>
<li>
<code>io</code> for <code>erlang_vm_statistics_bytes_output_total</code> and
<code>erlang_vm_statistics_bytes_received_total</code>.
<code>erlang_vm_statistics_bytes_received_total</code>;
</li>
<li>
<code>reductions</code> for <code>erlang_vm_statistics_reductions_total</code>.
<code>reductions</code> for <code>erlang_vm_statistics_reductions_total</code>;
</li>
<li>
<code>run_queue</code> for <code>erlang_vm_statistics_run_queues_length_total</code>.
<code>run_queue</code> for <code>erlang_vm_statistics_run_queues_length_total</code>;
</li>
<li>
<code>runtime</code> for <code>erlang_vm_statistics_runtime_milliseconds</code>.
<code>runtime</code> for <code>erlang_vm_statistics_runtime_milliseconds</code>;
</li>
<li>
<code>wall_clock</code> for <code>erlang_vm_statistics_wallclock_time_milliseconds</code>.
Expand All @@ -106,6 +106,6 @@ <h3><a name="Configuration">Configuration</a></h3>
By default all metrics are enabled.<hr>

<div class="navbar"><a name="#navbar_bottom"></a><table width="100%" border="0" cellspacing="0" cellpadding="2" summary="navigation bar"><tr><td><a href="overview-summary.html" target="overviewFrame">Overview</a></td><td><a href="http://www.erlang.org/"><img src="erlang.png" align="right" border="0" alt="erlang logo"></a></td></tr></table></div>
<p><i>Generated by EDoc, Sep 14 2016, 00:01:40.</i></p>
<p><i>Generated by EDoc, Sep 14 2016, 19:19:13.</i></p>
</body>
</html>
Original file line number Diff line number Diff line change
Expand Up @@ -96,20 +96,20 @@ Options are the same as Item parameter values for
erlang:statistics/1
](http://erlang.org/doc/man/erlang.md#statistics-1):

* `context_switches` for `erlang_vm_statistics_context_switches`.
* `context_switches` for `erlang_vm_statistics_context_switches`;

* `garbage_collection`
for `erlang_vm_statistics_garbage_collection_number_of_gcs` and
`erlang_vm_statistics_garbage_collection_words_reclaimed`.
`erlang_vm_statistics_garbage_collection_words_reclaimed`;

* `io` for `erlang_vm_statistics_bytes_output_total` and
`erlang_vm_statistics_bytes_received_total`.
`erlang_vm_statistics_bytes_received_total`;

* `reductions` for `erlang_vm_statistics_reductions_total`.
* `reductions` for `erlang_vm_statistics_reductions_total`;

* `run_queue` for `erlang_vm_statistics_run_queues_length_total`.
* `run_queue` for `erlang_vm_statistics_run_queues_length_total`;

* `runtime` for `erlang_vm_statistics_runtime_milliseconds`.
* `runtime` for `erlang_vm_statistics_runtime_milliseconds`;

* `wall_clock` for `erlang_vm_statistics_wallclock_time_milliseconds`.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -145,6 +145,6 @@ <h3><a name="Configuration">Configuration</a></h3>
By default all metrics are enabled.<hr>

<div class="navbar"><a name="#navbar_bottom"></a><table width="100%" border="0" cellspacing="0" cellpadding="2" summary="navigation bar"><tr><td><a href="overview-summary.html" target="overviewFrame">Overview</a></td><td><a href="http://www.erlang.org/"><img src="erlang.png" align="right" border="0" alt="erlang logo"></a></td></tr></table></div>
<p><i>Generated by EDoc, Sep 14 2016, 00:01:40.</i></p>
<p><i>Generated by EDoc, Sep 14 2016, 19:19:13.</i></p>
</body>
</html>
File renamed without changes.
File renamed without changes.
2 changes: 1 addition & 1 deletion rebar.config
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,6 @@
{xref_checks,[undefined_function_calls,undefined_functions,locals_not_used,
deprecated_function_calls,deprecated_functions]}.

{profiles, [{docs, [{edoc_opts, [{dir, "docs"}, {subpackages, true}]}]},
{profiles, [{docs, [{edoc_opts, [{dir, "doc"}, {subpackages, true}]}]},
{github, [{deps, [{edown, "0.8.1"}]},
{edoc_opts, [{doclet, edown_doclet}]}]}]}.
4 changes: 2 additions & 2 deletions src/collectors/vm/prometheus_vm_memory_collector.erl
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
%% @doc
%% Collects information about memory dynamically allocated
%% by the Erlang emulator usin
%% <a href="http://erlang.org/doc/man/erlang.html#statistics-1">
%% by the Erlang emulator using
%% <a href="http://erlang.org/doc/man/erlang.html#memory-0">
%% erlang:memory/0
%% </a>. Also provides basic (D)ETS statistics.
%%
Expand Down
12 changes: 6 additions & 6 deletions src/collectors/vm/prometheus_vm_statistics_collector.erl
Original file line number Diff line number Diff line change
Expand Up @@ -58,25 +58,25 @@
%% </a>:
%% <ul>
%% <li>
%% `context_switches' for `erlang_vm_statistics_context_switches'.
%% `context_switches' for `erlang_vm_statistics_context_switches';
%% </li>
%% <li>
%% `garbage_collection'
%% for `erlang_vm_statistics_garbage_collection_number_of_gcs' and
%% `erlang_vm_statistics_garbage_collection_words_reclaimed'.
%% `erlang_vm_statistics_garbage_collection_words_reclaimed';
%% </li>
%% <li>
%% `io' for `erlang_vm_statistics_bytes_output_total' and
%% `erlang_vm_statistics_bytes_received_total'.
%% `erlang_vm_statistics_bytes_received_total';
%% </li>
%% <li>
%% `reductions' for `erlang_vm_statistics_reductions_total'.
%% `reductions' for `erlang_vm_statistics_reductions_total';
%% </li>
%% <li>
%% `run_queue' for `erlang_vm_statistics_run_queues_length_total'.
%% `run_queue' for `erlang_vm_statistics_run_queues_length_total';
%% </li>
%% <li>
%% `runtime' for `erlang_vm_statistics_runtime_milliseconds'.
%% `runtime' for `erlang_vm_statistics_runtime_milliseconds';
%% </li>
%% <li>
%% `wall_clock' for `erlang_vm_statistics_wallclock_time_milliseconds'.
Expand Down

0 comments on commit c5c8ba6

Please sign in to comment.