Add documentation.

src/riak_control.erl

@@ -17,8 +17,9 @@
 %% under the License.
 %%
 %% -------------------------------------------------------------------
-
+%%
 %% @doc Utilities needed by many pieces of the riak_control app.
+%%
 -module(riak_control).
 
 -export([

src/riak_control_app.erl

@@ -17,6 +17,8 @@
 %% under the License.
 %%
 %% -------------------------------------------------------------------
+%%
+%% @doc Application.
 
 -module(riak_control_app).
 

src/riak_control_formatting.erl

@@ -17,6 +17,8 @@
 %% under the License.
 %%
 %% -------------------------------------------------------------------
+%%
+%% @doc Helper functions for formatting.
 
 -module(riak_control_formatting).
 

src/riak_control_routes.erl

@@ -17,6 +17,8 @@
 %% under the License.
 %%
 %% -------------------------------------------------------------------
+%%
+%% @doc Route helpers.
 
 -module(riak_control_routes).
 

src/riak_control_security.erl

@@ -17,8 +17,9 @@
 %% under the License.
 %%
 %% -------------------------------------------------------------------
-
+%%
 %% @doc SSL and Authorization enforcement for administration URLs.
+
 -module(riak_control_security).
 
 -export([scheme_is_available/2,

src/riak_control_session.erl

@@ -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).
 

src/riak_control_sup.erl

@@ -17,6 +17,8 @@
 %% under the License.
 %%
 %% -------------------------------------------------------------------
+%%
+%% @doc Application supervisor.
 
 -module(riak_control_sup).
 

src/riak_control_wm_cluster.erl

@@ -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).
 

src/riak_control_wm_gui.erl

@@ -17,6 +17,8 @@
 %% under the License.
 %%
 %% -------------------------------------------------------------------
+%%
+%% @doc Provides a resource for serving up the GUI skeleton.
 
 -module(riak_control_wm_gui).
 

src/riak_control_wm_nodes.erl

@@ -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).
 

src/riak_control_wm_partitions.erl

@@ -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).