Permalink
Browse files

Add documentation.

  • Loading branch information...
1 parent 9fd9e60 commit 4bbd014d00b27b1b461b51c11f9860871c2e6944 @cmeiklejohn cmeiklejohn committed Jun 10, 2013
View
@@ -17,8 +17,9 @@
%% under the License.
%%
%% -------------------------------------------------------------------
-
+%%
%% @doc Utilities needed by many pieces of the riak_control app.
+%%
-module(riak_control).
-export([
View
@@ -17,6 +17,8 @@
%% under the License.
%%
%% -------------------------------------------------------------------
+%%
+%% @doc Application.
-module(riak_control_app).
@@ -17,6 +17,8 @@
%% under the License.
%%
%% -------------------------------------------------------------------
+%%
+%% @doc Helper functions for formatting.
-module(riak_control_formatting).
@@ -17,6 +17,8 @@
%% under the License.
%%
%% -------------------------------------------------------------------
+%%
+%% @doc Route helpers.
-module(riak_control_routes).
@@ -17,8 +17,9 @@
%% under the License.
%%
%% -------------------------------------------------------------------
-
+%%
%% @doc SSL and Authorization enforcement for administration URLs.
+
-module(riak_control_security).
-export([scheme_is_available/2,
@@ -17,6 +17,9 @@
%% under the License.
%%
%% -------------------------------------------------------------------
+%%
+%% @doc Server responsible for tracking state of the Riak cluster and
+%% refreshing state on a particular interval.
-module(riak_control_session).
View
@@ -17,6 +17,8 @@
%% under the License.
%%
%% -------------------------------------------------------------------
+%%
+%% @doc Application supervisor.
-module(riak_control_sup).
@@ -18,16 +18,9 @@
%%
%% -------------------------------------------------------------------
%%
-%% @doc
-%%
-%% Responsible for viewing, staging and committing changes to the
-%% cluster.
-%%
-%% GET /cluster returns the current and staged clusters.
-%% PUT /cluster updates the plan.
-%% POST /cluster updates and commits the plan.
-%%
-%% @end
+%% @doc Provides a resource for getting the current cluster status,
+%% as well as a resource for updating the staged cluster plan, and
+%% committing the staged cluster plan.
-module(riak_control_wm_cluster).
@@ -17,6 +17,8 @@
%% under the License.
%%
%% -------------------------------------------------------------------
+%%
+%% @doc Provides a resource for serving up the GUI skeleton.
-module(riak_control_wm_gui).
@@ -18,13 +18,8 @@
%%
%% -------------------------------------------------------------------
%%
-%% @doc
-%%
-%% Responsible for viewing and modifying nodes.
-%%
-%% GET /nodes returns the node list.
-%%
-%% @end
+%% @doc Returns a list of all nodes, and information about their
+%% membership in the cluster.
-module(riak_control_wm_nodes).
@@ -17,6 +17,11 @@
%% under the License.
%%
%% -------------------------------------------------------------------
+%%
+%% @doc Returns a list of all partitions, how many primary replicas
+%% are available, what the current n_val and quorum
+%% configuration is, as well as the unavailable nodes for
+%% each partition.
-module(riak_control_wm_partitions).

0 comments on commit 4bbd014

Please sign in to comment.