Commits

justin  committed a1d3aef

more uniform license and doc markup

  • Participants
  • Parent commits 6431722

Comments (0)

Files changed (56)

File apps/riak/src/chash.erl

-%% @copyright 2007-2008 Basho Technologies
+%% -------------------------------------------------------------------
+%%
+%% chash: basic consistent hashing
+%%
+%% Copyright (c) 2007-2010 Basho Technologies, Inc.  All Rights Reserved.
+%%
+%% This file is provided to you under the Apache License,
+%% Version 2.0 (the "License"); you may not use this file
+%% except in compliance with the License.  You may obtain
+%% a copy of the License at
+%%
+%%   http://www.apache.org/licenses/LICENSE-2.0
+%%
+%% Unless required by applicable law or agreed to in writing,
+%% software distributed under the License is distributed on an
+%% "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+%% KIND, either express or implied.  See the License for the
+%% specific language governing permissions and limitations
+%% under the License.
+%%
+%% -------------------------------------------------------------------
 
 %% @reference Karger, D.; Lehman, E.; Leighton, T.; Panigrahy, R.; Levine, M.; Lewin, D. (1997). "Consistent hashing and random trees". Proceedings of the twenty-ninth annual ACM symposium on Theory of computing: 654~663. ACM Press New York, NY, USA
 
-% @author Justin Sheehy <justin@basho.com>
-% @author Andy Gross <andy@basho.com>
-
 % @doc A consistent hashing implementation.
 %      The space described by the ring coincides with SHA-1 hashes,
 %      and so any two keys producing the same SHA-1 hash are
 %      considered identical within the ring.
 
-%% Licensed under the Apache License, Version 2.0 (the "License");
-%% you may not use this file except in compliance with the License.
-%% You may obtain a copy of the License at
-
-%% http://www.apache.org/licenses/LICENSE-2.0
-
-%% Unless required by applicable law or agreed to in writing, software
-%% distributed under the License is distributed on an "AS IS" BASIS,
-%% WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-%% See the License for the specific language governing permissions and
-%% limitations under the License.
-
 -module(chash).
 -author('Justin Sheehy <justin@basho.com>').
 -author('Andy Gross <andy@basho.com>').

File apps/riak/src/mapred_resource.erl

+%% -------------------------------------------------------------------
+%%
+%% mapred_resource: webmachine resource for mapreduce requests
+%%
+%% Copyright (c) 2007-2010 Basho Technologies, Inc.  All Rights Reserved.
+%%
+%% This file is provided to you under the Apache License,
+%% Version 2.0 (the "License"); you may not use this file
+%% except in compliance with the License.  You may obtain
+%% a copy of the License at
+%%
+%%   http://www.apache.org/licenses/LICENSE-2.0
+%%
+%% Unless required by applicable law or agreed to in writing,
+%% software distributed under the License is distributed on an
+%% "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+%% KIND, either express or implied.  See the License for the
+%% specific language governing permissions and limitations
+%% under the License.
+%%
+%% -------------------------------------------------------------------
+
+%% @doc webmachine resource for mapreduce requests
+
 -module(mapred_resource).
 
 -export([init/1, service_available/2, allowed_methods/2]).

File apps/riak/src/merkerl.erl

-%% @copyright 2007-2008 Basho Technologies
+%% -------------------------------------------------------------------
+%%
+%% merkerl: simple in-memory Merkle Trees
+%%
+%% Copyright (c) 2007-2010 Basho Technologies, Inc.  All Rights Reserved.
+%%
+%% This file is provided to you under the Apache License,
+%% Version 2.0 (the "License"); you may not use this file
+%% except in compliance with the License.  You may obtain
+%% a copy of the License at
+%%
+%%   http://www.apache.org/licenses/LICENSE-2.0
+%%
+%% Unless required by applicable law or agreed to in writing,
+%% software distributed under the License is distributed on an
+%% "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+%% KIND, either express or implied.  See the License for the
+%% specific language governing permissions and limitations
+%% under the License.
+%%
+%% -------------------------------------------------------------------
+
 
 %% @reference Ralph C. Merkle, A Digital Signature Based on a Conventional Encryption Function, A Conference on the Theory and Applications of Cryptographic Techniques on Advances in Cryptology, p.369-378, August 16-20, 1987 
 
-% @author Justin Sheehy <justin@basho.com>
-
-% @doc An implementation of Merkle Trees for anti-entropy.
-%
+%% @doc simple in-memory Merkle Trees.
 % Intended use is for synchronizing two key/value stores with
 % similar but potentially-divergent content.
 %
 %
 % Application usage note: the 'crypto' OTP application must be started
 % before any of this module's functions will work.
-%
-%% Licensed under the Apache License, Version 2.0 (the "License");
-%% you may not use this file except in compliance with the License.
-%% You may obtain a copy of the License at
-%
-%% http://www.apache.org/licenses/LICENSE-2.0
-%
-%% Unless required by applicable law or agreed to in writing, software
-%% distributed under the License is distributed on an "AS IS" BASIS,
-%% WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-%% See the License for the specific language governing permissions and
-%% limitations under the License.
 
 -module(merkerl).
 -export([insert/2,delete/2,build_tree/1,diff/2,allkeys/1]).

File apps/riak/src/ping_http_resource.erl

+%% -------------------------------------------------------------------
+%%
+%% ping_http_resource: simple Webmachine resource for availability test
+%%
+%% Copyright (c) 2007-2010 Basho Technologies, Inc.  All Rights Reserved.
+%%
 %% This file is provided to you under the Apache License,
 %% Version 2.0 (the "License"); you may not use this file
 %% except in compliance with the License.  You may obtain
 %% a copy of the License at
-
+%%
 %%   http://www.apache.org/licenses/LICENSE-2.0
-
+%%
 %% Unless required by applicable law or agreed to in writing,
 %% software distributed under the License is distributed on an
 %% "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 %% KIND, either express or implied.  See the License for the
 %% specific language governing permissions and limitations
 %% under the License.
+%%
+%% -------------------------------------------------------------------
+
+%% @doc simple Webmachine resource for availability test
 
 -module(ping_http_resource).
 -author('Dave Smith <dizzyd@dizzyd.com>').

File apps/riak/src/raw_http_resource.erl

+%% -------------------------------------------------------------------
+%%
+%% raw_http_resource: Webmachine resource for serving Riak data
+%%
+%% Copyright (c) 2007-2010 Basho Technologies, Inc.  All Rights Reserved.
+%%
 %% This file is provided to you under the Apache License,
 %% Version 2.0 (the "License"); you may not use this file
 %% except in compliance with the License.  You may obtain
 %% a copy of the License at
-
+%%
 %%   http://www.apache.org/licenses/LICENSE-2.0
-
+%%
 %% Unless required by applicable law or agreed to in writing,
 %% software distributed under the License is distributed on an
 %% "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 %% KIND, either express or implied.  See the License for the
 %% specific language governing permissions and limitations
 %% under the License.
+%%
+%% -------------------------------------------------------------------
 
-%% @doc Resource for serving Riak objects over HTTP.
-%%
+%% @doc Webmachine resource for serving Riak data.
 %% Available operations:
 %%
 %% GET /Prefix/Bucket

File apps/riak/src/riak.erl

+%% -------------------------------------------------------------------
+%%
+%% Riak: A lightweight, decentralized key-value store.
+%%
+%% Copyright (c) 2007-2010 Basho Technologies, Inc.  All Rights Reserved.
+%%
 %% This file is provided to you under the Apache License,
 %% Version 2.0 (the "License"); you may not use this file
 %% except in compliance with the License.  You may obtain
 %% a copy of the License at
-
+%%
 %%   http://www.apache.org/licenses/LICENSE-2.0
-
+%%
 %% Unless required by applicable law or agreed to in writing,
 %% software distributed under the License is distributed on an
 %% "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 %% KIND, either express or implied.  See the License for the
 %% specific language governing permissions and limitations
-%% under the License.    
-
-%% @doc Riak: A lightweight, decentralized key-value store.
-%% @author Andy Gross <andy@basho.com>
-%% @author Justin Sheehy <justin@basho.com>
-%% @author Bryan Fink <bryan@basho.com>
-%% @copyright 2007-2009 Basho Technologies, Inc.  All Rights Reserved.
+%% under the License.
+%%
+%% -------------------------------------------------------------------
 
 -module(riak).
 -author('Andy Gross <andy@basho.com>').

File apps/riak/src/riak_app.erl

+%% -------------------------------------------------------------------
+%%
+%% riak_app: application startup for Riak
+%%
+%% Copyright (c) 2007-2010 Basho Technologies, Inc.  All Rights Reserved.
+%%
 %% This file is provided to you under the Apache License,
 %% Version 2.0 (the "License"); you may not use this file
 %% except in compliance with the License.  You may obtain
 %% a copy of the License at
-
+%%
 %%   http://www.apache.org/licenses/LICENSE-2.0
-
+%%
 %% Unless required by applicable law or agreed to in writing,
 %% software distributed under the License is distributed on an
 %% "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 %% KIND, either express or implied.  See the License for the
 %% specific language governing permissions and limitations
-%% under the License.    
+%% under the License.
+%%
+%% -------------------------------------------------------------------
 
-%% @doc Bootstrapping the Riak application.
+%% @doc application startup for Riak
 
 -module(riak_app).
 

File apps/riak/src/riak_backup.erl

+%% -------------------------------------------------------------------
+%%
+%% riak_backup: utilities for backup and restore of Riak nodes and clusters
+%%
+%% Copyright (c) 2007-2010 Basho Technologies, Inc.  All Rights Reserved.
+%%
 %% This file is provided to you under the Apache License,
 %% Version 2.0 (the "License"); you may not use this file
 %% except in compliance with the License.  You may obtain
 %% a copy of the License at
-
+%%
 %%   http://www.apache.org/licenses/LICENSE-2.0
-
+%%
 %% Unless required by applicable law or agreed to in writing,
 %% software distributed under the License is distributed on an
 %% "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 %% KIND, either express or implied.  See the License for the
 %% specific language governing permissions and limitations
-%% under the License.    
+%% under the License.
+%%
+%% -------------------------------------------------------------------
 
-%% @doc Utilities for backup and restore of a riak cluster.
+%% @doc utilities for backup and restore of Riak nodes and clusters.
+
 %%      Note that if you want to restore to exactly the contents of
 %%      a dump, you should restore to an empty cluster.  Otherwise,
 %%      restore will reconcile values with the existing data.

File apps/riak/src/riak_bucket.erl

+%% -------------------------------------------------------------------
+%%
+%% riak_bucket: manipulation of Riak bucket properties
+%%
+%% Copyright (c) 2007-2010 Basho Technologies, Inc.  All Rights Reserved.
+%%
 %% This file is provided to you under the Apache License,
 %% Version 2.0 (the "License"); you may not use this file
 %% except in compliance with the License.  You may obtain
 %% a copy of the License at
-
+%%
 %%   http://www.apache.org/licenses/LICENSE-2.0
-
+%%
 %% Unless required by applicable law or agreed to in writing,
 %% software distributed under the License is distributed on an
 %% "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 %% KIND, either express or implied.  See the License for the
 %% specific language governing permissions and limitations
 %% under the License.
+%%
+%% -------------------------------------------------------------------
 
-%% @doc Functions for manipulating bucket properties.
+%% @doc manipulation of Riak bucket properties
+
 %% @type riak_bucketprops() = [{Propkey :: atom(), Propval :: term()}]
 
 -module(riak_bucket).

File apps/riak/src/riak_cache_backend.erl

+%% -------------------------------------------------------------------
+%%
+%% riak_cache_backend: buckets as in-memory caches
+%%
+%% Copyright (c) 2007-2010 Basho Technologies, Inc.  All Rights Reserved.
+%%
 %% This file is provided to you under the Apache License,
 %% Version 2.0 (the "License"); you may not use this file
 %% except in compliance with the License.  You may obtain
 %% a copy of the License at
-
+%%
 %%   http://www.apache.org/licenses/LICENSE-2.0
-
+%%
 %% Unless required by applicable law or agreed to in writing,
 %% software distributed under the License is distributed on an
 %% "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 %% KIND, either express or implied.  See the License for the
 %% specific language governing permissions and limitations
-%% under the License.    
+%% under the License.
+%%
+%% -------------------------------------------------------------------
 
-%% @doc
-%% riak_cache_backend is a backend that turns a bucket into a 
+%% @doc riak_cache_backend is a backend that turns a bucket into a 
 %% memcached-type memory cache. Ejects the least recently used
 %% objects either when cache gets full or the object's lease
 %% expires.

File apps/riak/src/riak_claim.erl

+%% -------------------------------------------------------------------
+%%
+%% riak_claim: default functions used for claiming partition ownership
+%%
+%% Copyright (c) 2007-2010 Basho Technologies, Inc.  All Rights Reserved.
+%%
 %% This file is provided to you under the Apache License,
 %% Version 2.0 (the "License"); you may not use this file
 %% except in compliance with the License.  You may obtain
 %% a copy of the License at
-
+%%
 %%   http://www.apache.org/licenses/LICENSE-2.0
-
+%%
 %% Unless required by applicable law or agreed to in writing,
 %% software distributed under the License is distributed on an
 %% "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 %% KIND, either express or implied.  See the License for the
 %% specific language governing permissions and limitations
-%% under the License.    
+%% under the License.
+%%
+%% -------------------------------------------------------------------
 
-%% @doc The default functions used for claiming partition ownership.
+%% @doc default functions used for claiming partition ownership.
+
 %%      Generally, a wants_claim function should return either
 %%      {yes, Integer} or 'no' where Integer is the number of
 %%       additional partitions wanted by this node.

File apps/riak/src/riak_client.erl

+%% -------------------------------------------------------------------
+%%
+%% riak_client: object used for access into the riak system
+%%
+%% Copyright (c) 2007-2010 Basho Technologies, Inc.  All Rights Reserved.
+%%
 %% This file is provided to you under the Apache License,
 %% Version 2.0 (the "License"); you may not use this file
 %% except in compliance with the License.  You may obtain
 %% a copy of the License at
-
+%%
 %%   http://www.apache.org/licenses/LICENSE-2.0
-
+%%
 %% Unless required by applicable law or agreed to in writing,
 %% software distributed under the License is distributed on an
 %% "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 %% KIND, either express or implied.  See the License for the
 %% specific language governing permissions and limitations
 %% under the License.
+%%
+%% -------------------------------------------------------------------
 
-%% @doc The client object used for all access into the riak system.
+%% @doc object used for access into the riak system
+
 %% @type riak_client() = term()
 
 -module(riak_client, [Node,ClientId]).

File apps/riak/src/riak_connect.erl

+%% -------------------------------------------------------------------
+%%
+%% riak_connect: ring gossip and partition claiming
+%%
+%% Copyright (c) 2007-2010 Basho Technologies, Inc.  All Rights Reserved.
+%%
 %% This file is provided to you under the Apache License,
 %% Version 2.0 (the "License"); you may not use this file
 %% except in compliance with the License.  You may obtain
 %% a copy of the License at
-
+%%
 %%   http://www.apache.org/licenses/LICENSE-2.0
-
+%%
 %% Unless required by applicable law or agreed to in writing,
 %% software distributed under the License is distributed on an
 %% "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 %% KIND, either express or implied.  See the License for the
 %% specific language governing permissions and limitations
-%% under the License.    
+%% under the License.
+%%
+%% -------------------------------------------------------------------
 
-%% @doc
-%% riak_connect takes care of the mechanics of shuttling a
-%% from one node to another upon request by other
-%% Riak processes.
-%%
-%% Additionally, it occasionally checks to make sure the current
-%% node has its fair share of partitions, and also sends
-%% a copy of the ring to some other random node, ensuring
-%% that all nodes eventually synchronize on the same understanding
-%% of the Riak cluster. This interval is configurable, but defaults
-%% to once per minute.
+%% @doc ring gossip and partition claiming
 
 -module(riak_connect).
 

File apps/riak/src/riak_console.erl

+%% -------------------------------------------------------------------
+%%
+%% riak_console: interface for Riak admin commands
+%%
+%% Copyright (c) 2007-2010 Basho Technologies, Inc.  All Rights Reserved.
+%%
 %% This file is provided to you under the Apache License,
 %% Version 2.0 (the "License"); you may not use this file
 %% except in compliance with the License.  You may obtain
 %% a copy of the License at
-
+%%
 %%   http://www.apache.org/licenses/LICENSE-2.0
-
+%%
 %% Unless required by applicable law or agreed to in writing,
 %% software distributed under the License is distributed on an
 %% "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 %% KIND, either express or implied.  See the License for the
 %% specific language governing permissions and limitations
-%% under the License.    
+%% under the License.
+%%
+%% -------------------------------------------------------------------
 
-%% @doc Riak: A lightweight, decentralized key-value store.
-%% @author Andy Gross <andy@basho.com>
-%% @author Justin Sheehy <justin@basho.com>
-%% @author Bryan Fink <bryan@basho.com>
-%% @copyright 2007-2009 Basho Technologies, Inc.  All Rights Reserved.
+%% @doc interface for Riak admin commands
+
 -module(riak_console).
 
 -export([join/1, status/1, reip/1]).

File apps/riak/src/riak_delete.erl

+%% -------------------------------------------------------------------
+%%
+%% riak_delete: two-step object deletion
+%%
+%% Copyright (c) 2007-2010 Basho Technologies, Inc.  All Rights Reserved.
+%%
 %% This file is provided to you under the Apache License,
 %% Version 2.0 (the "License"); you may not use this file
 %% except in compliance with the License.  You may obtain
 %% a copy of the License at
-
+%%
 %%   http://www.apache.org/licenses/LICENSE-2.0
-
+%%
 %% Unless required by applicable law or agreed to in writing,
 %% software distributed under the License is distributed on an
 %% "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 %% KIND, either express or implied.  See the License for the
 %% specific language governing permissions and limitations
-%% under the License.    
+%% under the License.
+%%
+%% -------------------------------------------------------------------
 
-%% @doc Interface for object deletion.
+%% @doc two-step object deletion
 
 -module(riak_delete).
 

File apps/riak/src/riak_dets_backend.erl

+%% -------------------------------------------------------------------
+%%
+%% riak_dets_backend: storage engine based on DETS tables
+%%
+%% Copyright (c) 2007-2010 Basho Technologies, Inc.  All Rights Reserved.
+%%
 %% This file is provided to you under the Apache License,
 %% Version 2.0 (the "License"); you may not use this file
 %% except in compliance with the License.  You may obtain
 %% a copy of the License at
-
+%%
 %%   http://www.apache.org/licenses/LICENSE-2.0
-
+%%
 %% Unless required by applicable law or agreed to in writing,
 %% software distributed under the License is distributed on an
 %% "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 %% KIND, either express or implied.  See the License for the
 %% specific language governing permissions and limitations
-%% under the License.    
+%% under the License.
+%%
+%% -------------------------------------------------------------------
 
-%% @doc riak_dets_backend is a Riak storage backend using dets.
+%% @doc storage engine based on DETS tables
 
 -module(riak_dets_backend).
 

File apps/riak/src/riak_ets_backend.erl

+%% -------------------------------------------------------------------
+%%
+%% riak_ets_backend: storage engine based on ETS tables
+%%
+%% Copyright (c) 2007-2010 Basho Technologies, Inc.  All Rights Reserved.
+%%
 %% This file is provided to you under the Apache License,
 %% Version 2.0 (the "License"); you may not use this file
 %% except in compliance with the License.  You may obtain
 %% a copy of the License at
-
+%%
 %%   http://www.apache.org/licenses/LICENSE-2.0
-
+%%
 %% Unless required by applicable law or agreed to in writing,
 %% software distributed under the License is distributed on an
 %% "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 %% KIND, either express or implied.  See the License for the
 %% specific language governing permissions and limitations
 %% under the License.
+%%
+%% -------------------------------------------------------------------
 
-% @doc riak_ets_backend is a Riak storage backend using ets.
+%% @doc storage engine based on ETS tables
 
 -module(riak_ets_backend).
 -behaviour(gen_server).

File apps/riak/src/riak_event_logger.erl

+%% -------------------------------------------------------------------
+%%
+%% riak_event_logger: example of use of Riak's internal events
+%%
+%% Copyright (c) 2007-2010 Basho Technologies, Inc.  All Rights Reserved.
+%%
 %% This file is provided to you under the Apache License,
 %% Version 2.0 (the "License"); you may not use this file
 %% except in compliance with the License.  You may obtain
 %% a copy of the License at
-
+%%
 %%   http://www.apache.org/licenses/LICENSE-2.0
-
+%%
 %% Unless required by applicable law or agreed to in writing,
 %% software distributed under the License is distributed on an
 %% "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 %% KIND, either express or implied.  See the License for the
 %% specific language governing permissions and limitations
 %% under the License.
+%%
+%% -------------------------------------------------------------------
 
-%% @doc
-%% riak_event_logger is an example of how to connect to a
-%% running Riak cluster to receive events.
+%% @doc example of use of Riak's internal events
 
 -module(riak_event_logger).
 -behavior(gen_server).

File apps/riak/src/riak_eventer.erl

+%% -------------------------------------------------------------------
+%%
+%% riak_eventer: Riak internal events
+%%
+%% Copyright (c) 2007-2010 Basho Technologies, Inc.  All Rights Reserved.
+%%
 %% This file is provided to you under the Apache License,
 %% Version 2.0 (the "License"); you may not use this file
 %% except in compliance with the License.  You may obtain
 %% a copy of the License at
-
+%%
 %%   http://www.apache.org/licenses/LICENSE-2.0
-
+%%
 %% Unless required by applicable law or agreed to in writing,
 %% software distributed under the License is distributed on an
 %% "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 %% KIND, either express or implied.  See the License for the
 %% specific language governing permissions and limitations
-%% under the License.    
+%% under the License.
+%%
+%% -------------------------------------------------------------------
 
-%%
-%% @doc
-%% Riak events provide information about what is happening behind-the-scenes
-%% in a Riak cluster. 
+%% @doc Riak events provide information about what is happening
+%% behind-the-scenes in a Riak cluster. 
 %%
 %% Events are generated using {@link notify/1} or {@link notify/3}. 
 %% Each event consists of a Module, an EventName, the Node on which 
     ?assert(length(get_matching_handlers({riak_vnode, ignored, ignored, ignored}, Handlers)) == 4),    
     ?assert(length(get_matching_handlers({riak_vnode, delete, ignored, ignored}, Handlers)) == 6).
     
-    
+    

File apps/riak/src/riak_fs_backend.erl

+%% -------------------------------------------------------------------
+%%
+%% riak_fs_backend: storage engine based on basic filesystem access
+%%
+%% Copyright (c) 2007-2010 Basho Technologies, Inc.  All Rights Reserved.
+%%
 %% This file is provided to you under the Apache License,
 %% Version 2.0 (the "License"); you may not use this file
 %% except in compliance with the License.  You may obtain
 %% a copy of the License at
-
+%%
 %%   http://www.apache.org/licenses/LICENSE-2.0
-
+%%
 %% Unless required by applicable law or agreed to in writing,
 %% software distributed under the License is distributed on an
 %% "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 %% KIND, either express or implied.  See the License for the
 %% specific language governing permissions and limitations
-%% under the License.    
+%% under the License.
+%%
+%% -------------------------------------------------------------------
 
-% @doc riak_fs_backend is a simple filesystem storage system.
+%% @doc storage engine based on basic filesystem access
 
 -module(riak_fs_backend).
 -export([start/2,stop/1,get/2,put/3,list/1,list_bucket/2,delete/2]).

File apps/riak/src/riak_gb_trees_backend.erl

+%% -------------------------------------------------------------------
+%%
+%% riak_gb_trees_backend: storage engine based on gb_trees
+%%
+%% Copyright (c) 2007-2010 Basho Technologies, Inc.  All Rights Reserved.
+%%
 %% This file is provided to you under the Apache License,
 %% Version 2.0 (the "License"); you may not use this file
 %% except in compliance with the License.  You may obtain
 %% a copy of the License at
-
+%%
 %%   http://www.apache.org/licenses/LICENSE-2.0
-
+%%
 %% Unless required by applicable law or agreed to in writing,
 %% software distributed under the License is distributed on an
 %% "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 %% KIND, either express or implied.  See the License for the
 %% specific language governing permissions and limitations
-%% under the License.    
+%% under the License.
+%%
+%% -------------------------------------------------------------------
 
-%% @doc riak_gb_trees_backend is a Riak storage backend using Erlang gb_trees.
+%% @doc storage engine based on gb_trees
 
 -module(riak_gb_trees_backend).
 

File apps/riak/src/riak_get_fsm.erl

+%% -------------------------------------------------------------------
+%%
+%% riak_get_fsm: coordination of Riak GET requests
+%%
+%% Copyright (c) 2007-2010 Basho Technologies, Inc.  All Rights Reserved.
+%%
 %% This file is provided to you under the Apache License,
 %% Version 2.0 (the "License"); you may not use this file
 %% except in compliance with the License.  You may obtain
 %% a copy of the License at
-
+%%
 %%   http://www.apache.org/licenses/LICENSE-2.0
-
+%%
 %% Unless required by applicable law or agreed to in writing,
 %% software distributed under the License is distributed on an
 %% "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 %% KIND, either express or implied.  See the License for the
 %% specific language governing permissions and limitations
-%% under the License.    
+%% under the License.
+%%
+%% -------------------------------------------------------------------
 
 -module(riak_get_fsm).
 -behaviour(gen_fsm).

File apps/riak/src/riak_handoff_listener.erl

+%% -------------------------------------------------------------------
+%%
+%% riak_handoff_listener: entry point for TCP-based handoff
+%%
+%% Copyright (c) 2007-2010 Basho Technologies, Inc.  All Rights Reserved.
+%%
 %% This file is provided to you under the Apache License,
 %% Version 2.0 (the "License"); you may not use this file
 %% except in compliance with the License.  You may obtain
 %% a copy of the License at
-
+%%
 %%   http://www.apache.org/licenses/LICENSE-2.0
-
+%%
 %% Unless required by applicable law or agreed to in writing,
 %% software distributed under the License is distributed on an
 %% "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 %% KIND, either express or implied.  See the License for the
 %% specific language governing permissions and limitations
-%% under the License.    
+%% under the License.
+%%
+%% -------------------------------------------------------------------
+
+%% @doc entry point for TCP-based handoff
 
 -module(riak_handoff_listener).
 -behavior(gen_nb_server).

File apps/riak/src/riak_handoff_receiver.erl

+%% -------------------------------------------------------------------
+%%
+%% riak_handoff_receiver: incoming data handler for TCP-based handoff
+%%
+%% Copyright (c) 2007-2010 Basho Technologies, Inc.  All Rights Reserved.
+%%
 %% This file is provided to you under the Apache License,
 %% Version 2.0 (the "License"); you may not use this file
 %% except in compliance with the License.  You may obtain
 %% a copy of the License at
-
+%%
 %%   http://www.apache.org/licenses/LICENSE-2.0
-
+%%
 %% Unless required by applicable law or agreed to in writing,
 %% software distributed under the License is distributed on an
 %% "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 %% KIND, either express or implied.  See the License for the
 %% specific language governing permissions and limitations
-%% under the License.    
+%% under the License.
+%%
+%% -------------------------------------------------------------------
+
+%% @doc incoming data handler for TCP-based handoff
 
 -module(riak_handoff_receiver).
 -include("riakserver_pb.hrl").

File apps/riak/src/riak_handoff_sender.erl

+%% -------------------------------------------------------------------
+%%
+%% riak_handoff_sender: send a partition's data via TCP-based handoff
+%%
+%% Copyright (c) 2007-2010 Basho Technologies, Inc.  All Rights Reserved.
+%%
 %% This file is provided to you under the Apache License,
 %% Version 2.0 (the "License"); you may not use this file
 %% except in compliance with the License.  You may obtain
 %% a copy of the License at
-
+%%
 %%   http://www.apache.org/licenses/LICENSE-2.0
-
+%%
 %% Unless required by applicable law or agreed to in writing,
 %% software distributed under the License is distributed on an
 %% "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 %% KIND, either express or implied.  See the License for the
 %% specific language governing permissions and limitations
-%% under the License.    
+%% under the License.
+%%
+%% -------------------------------------------------------------------
+
+%% @doc send a partition's data via TCP-based handoff
 
 -module(riak_handoff_sender).
 -export([start_link/3]).

File apps/riak/src/riak_js_manager.erl

+%% -------------------------------------------------------------------
+%%
+%% riak_js_manager: dispatch work to JavaScript VMs
+%%
+%% Copyright (c) 2007-2010 Basho Technologies, Inc.  All Rights Reserved.
+%%
 %% This file is provided to you under the Apache License,
 %% Version 2.0 (the "License"); you may not use this file
 %% except in compliance with the License.  You may obtain
 %% a copy of the License at
-
+%%
 %%   http://www.apache.org/licenses/LICENSE-2.0
-
+%%
 %% Unless required by applicable law or agreed to in writing,
 %% software distributed under the License is distributed on an
 %% "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 %% KIND, either express or implied.  See the License for the
 %% specific language governing permissions and limitations
 %% under the License.
+%%
+%% -------------------------------------------------------------------
+
+%% @doc dispatch work to JavaScript VMs
 
 -module(riak_js_manager).
 

File apps/riak/src/riak_js_sup.erl

+%% -------------------------------------------------------------------
+%%
+%% riak_js_sup: supervise JavaScript VMs
+%%
+%% Copyright (c) 2007-2010 Basho Technologies, Inc.  All Rights Reserved.
+%%
 %% This file is provided to you under the Apache License,
 %% Version 2.0 (the "License"); you may not use this file
 %% except in compliance with the License.  You may obtain
 %% a copy of the License at
-
+%%
 %%   http://www.apache.org/licenses/LICENSE-2.0
-
+%%
 %% Unless required by applicable law or agreed to in writing,
 %% software distributed under the License is distributed on an
 %% "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 %% KIND, either express or implied.  See the License for the
 %% specific language governing permissions and limitations
 %% under the License.
+%%
+%% -------------------------------------------------------------------
+
+%% @doc supervise JavaScript VMs
+
 -module(riak_js_sup).
 -behaviour(supervisor).
 -export([start_link/0, init/1, stop/1]).

File apps/riak/src/riak_js_vm.erl

+%% -------------------------------------------------------------------
+%%
+%% riak_js_vm: interaction with JavaScript VMs
+%%
+%% Copyright (c) 2007-2010 Basho Technologies, Inc.  All Rights Reserved.
+%%
 %% This file is provided to you under the Apache License,
 %% Version 2.0 (the "License"); you may not use this file
 %% except in compliance with the License.  You may obtain
 %% a copy of the License at
-
+%%
 %%   http://www.apache.org/licenses/LICENSE-2.0
-
+%%
 %% Unless required by applicable law or agreed to in writing,
 %% software distributed under the License is distributed on an
 %% "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 %% KIND, either express or implied.  See the License for the
 %% specific language governing permissions and limitations
 %% under the License.
+%%
+%% -------------------------------------------------------------------
+
+%% @doc interaction with JavaScript VMs
 
 -module(riak_js_vm).
 

File apps/riak/src/riak_keys_fsm.erl

+%% -------------------------------------------------------------------
+%%
+%% riak_keys_fsm: listing of bucket keys
+%%
+%% Copyright (c) 2007-2010 Basho Technologies, Inc.  All Rights Reserved.
+%%
 %% This file is provided to you under the Apache License,
 %% Version 2.0 (the "License"); you may not use this file
 %% except in compliance with the License.  You may obtain
 %% a copy of the License at
-
+%%
 %%   http://www.apache.org/licenses/LICENSE-2.0
-
+%%
 %% Unless required by applicable law or agreed to in writing,
 %% software distributed under the License is distributed on an
 %% "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 %% KIND, either express or implied.  See the License for the
 %% specific language governing permissions and limitations
 %% under the License.
+%%
+%% -------------------------------------------------------------------
+
+%% @doc listing of bucket keys
 
 -module(riak_keys_fsm).
 -behaviour(gen_fsm).

File apps/riak/src/riak_local_logger.erl

+%% -------------------------------------------------------------------
+%%
+%% riak_local_logger: logging in basic text file form
+%%
+%% Copyright (c) 2007-2010 Basho Technologies, Inc.  All Rights Reserved.
+%%
 %% This file is provided to you under the Apache License,
 %% Version 2.0 (the "License"); you may not use this file
 %% except in compliance with the License.  You may obtain
 %% a copy of the License at
-
+%%
 %%   http://www.apache.org/licenses/LICENSE-2.0
-
+%%
 %% Unless required by applicable law or agreed to in writing,
 %% software distributed under the License is distributed on an
 %% "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 %% KIND, either express or implied.  See the License for the
 %% specific language governing permissions and limitations
-%% under the License.    
+%% under the License.
+%%
+%% -------------------------------------------------------------------
+
+%% @doc logging in basic text file form
 
 -module(riak_local_logger).
 -behavior(gen_server2).

File apps/riak/src/riak_map_executor.erl

+%% -------------------------------------------------------------------
+%%
+%% riak_map_executor: perform work for map-phase jobs
+%%
+%% Copyright (c) 2007-2010 Basho Technologies, Inc.  All Rights Reserved.
+%%
 %% This file is provided to you under the Apache License,
 %% Version 2.0 (the "License"); you may not use this file
 %% except in compliance with the License.  You may obtain
 %% a copy of the License at
-
+%%
 %%   http://www.apache.org/licenses/LICENSE-2.0
-
+%%
 %% Unless required by applicable law or agreed to in writing,
 %% software distributed under the License is distributed on an
 %% "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 %% KIND, either express or implied.  See the License for the
 %% specific language governing permissions and limitations
 %% under the License.
+%%
+%% -------------------------------------------------------------------
+
+%% @doc perform work for map-phase jobs
 
 -module(riak_map_executor).
 -behaviour(gen_fsm).

File apps/riak/src/riak_map_localphase.erl

+%% -------------------------------------------------------------------
+%%
+%% riak_map_localphase: node-local portion of map-phase management
+%%
+%% Copyright (c) 2007-2010 Basho Technologies, Inc.  All Rights Reserved.
+%%
 %% This file is provided to you under the Apache License,
 %% Version 2.0 (the "License"); you may not use this file
 %% except in compliance with the License.  You may obtain
 %% a copy of the License at
-
+%%
 %%   http://www.apache.org/licenses/LICENSE-2.0
-
+%%
 %% Unless required by applicable law or agreed to in writing,
 %% software distributed under the License is distributed on an
 %% "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 %% KIND, either express or implied.  See the License for the
 %% specific language governing permissions and limitations
-%% under the License.    
+%% under the License.
+%%
+%% -------------------------------------------------------------------
+
+%% @doc node-local portion of map-phase management
 
 -module(riak_map_localphase).
 -behaviour(gen_fsm).

File apps/riak/src/riak_map_phase.erl

+%% -------------------------------------------------------------------
+%%
+%% riak_map_phase: manage the mechanics of a map phase of a MR job
+%%
+%% Copyright (c) 2007-2010 Basho Technologies, Inc.  All Rights Reserved.
+%%
 %% This file is provided to you under the Apache License,
 %% Version 2.0 (the "License"); you may not use this file
 %% except in compliance with the License.  You may obtain
 %% a copy of the License at
-
+%%
 %%   http://www.apache.org/licenses/LICENSE-2.0
-
+%%
 %% Unless required by applicable law or agreed to in writing,
 %% software distributed under the License is distributed on an
 %% "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 %% KIND, either express or implied.  See the License for the
 %% specific language governing permissions and limitations
 %% under the License.
+%%
+%% -------------------------------------------------------------------
 
 -module(riak_map_phase).
 

File apps/riak/src/riak_mapred_json.erl

+%% -------------------------------------------------------------------
+%%
+%% riak_mapred_json: JSON parsing for mapreduce
+%%
+%% Copyright (c) 2007-2010 Basho Technologies, Inc.  All Rights Reserved.
+%%
+%% This file is provided to you under the Apache License,
+%% Version 2.0 (the "License"); you may not use this file
+%% except in compliance with the License.  You may obtain
+%% a copy of the License at
+%%
+%%   http://www.apache.org/licenses/LICENSE-2.0
+%%
+%% Unless required by applicable law or agreed to in writing,
+%% software distributed under the License is distributed on an
+%% "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+%% KIND, either express or implied.  See the License for the
+%% specific language governing permissions and limitations
+%% under the License.
+%%
+%% -------------------------------------------------------------------
+
+%% @doc JSON parsing for mapreduce
+
 -module(riak_mapred_json).
 
 -export([parse_inputs/1, parse_query/1]).

File apps/riak/src/riak_mapred_query.erl

+%% -------------------------------------------------------------------
+%%
+%% riak_mapred_query: driver for mapreduce query
+%%
+%% Copyright (c) 2007-2010 Basho Technologies, Inc.  All Rights Reserved.
+%%
 %% This file is provided to you under the Apache License,
 %% Version 2.0 (the "License"); you may not use this file
 %% except in compliance with the License.  You may obtain
 %% a copy of the License at
-
+%%
 %%   http://www.apache.org/licenses/LICENSE-2.0
-
+%%
 %% Unless required by applicable law or agreed to in writing,
 %% software distributed under the License is distributed on an
 %% "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 %% KIND, either express or implied.  See the License for the
 %% specific language governing permissions and limitations
 %% under the License.
+%%
+%% -------------------------------------------------------------------
 
-%% @doc riak_mapred_query is the driver of a mapreduce query.
-%%
+%% @doc driver for mapreduce query.
 %%      Map phases are expected to have inputs of the form
 %%      [{Bucket,Key}] or [{{Bucket,Key},KeyData}] (the first form is
 %%      equivalent to [{{Bucket,Key},undefined}]) and will execute

File apps/riak/src/riak_mapreduce.erl

+%% -------------------------------------------------------------------
+%%
+%% riak_mapreduce: convenience functions for defining common map/reduce phases
+%%
+%% Copyright (c) 2007-2010 Basho Technologies, Inc.  All Rights Reserved.
+%%
 %% This file is provided to you under the Apache License,
 %% Version 2.0 (the "License"); you may not use this file
 %% except in compliance with the License.  You may obtain
 %% a copy of the License at
-
+%%
 %%   http://www.apache.org/licenses/LICENSE-2.0
-
+%%
 %% Unless required by applicable law or agreed to in writing,
 %% software distributed under the License is distributed on an
 %% "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 %% KIND, either express or implied.  See the License for the
 %% specific language governing permissions and limitations
-%% under the License.    
+%% under the License.
+%%
+%% -------------------------------------------------------------------
 
-%% @doc Convenience functions for defining common map/reduce phases.
+%% @doc convenience functions for defining common map/reduce phases
+
 -module(riak_mapreduce).
 
 %% phase spec producers

File apps/riak/src/riak_multi_backend.erl

+%% -------------------------------------------------------------------
+%%
+%% riak_multi_backend: switching between multiple storage engines
+%%
+%% Copyright (c) 2007-2010 Basho Technologies, Inc.  All Rights Reserved.
+%%
 %% This file is provided to you under the Apache License,
 %% Version 2.0 (the "License"); you may not use this file
 %% except in compliance with the License.  You may obtain
 %% a copy of the License at
-
+%%
 %%   http://www.apache.org/licenses/LICENSE-2.0
-
+%%
 %% Unless required by applicable law or agreed to in writing,
 %% software distributed under the License is distributed on an
 %% "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 %% KIND, either express or implied.  See the License for the
 %% specific language governing permissions and limitations
-%% under the License.    
-
-%% @doc riak_gb_trees_backend is a Riak storage backend using Erlang gb_trees.
+%% under the License.
+%%
+%% -------------------------------------------------------------------
 
 -module (riak_multi_backend).
 -export([start/2, stop/1,get/2,put/3,list/1,list_bucket/2,delete/2,is_empty/1,drop/1,fold/3]).
 
 -record (state, {backends, default_backend}).
 
-%% @doc
-%% riak_multi_backend allows you to run multiple backends within a 
+%% @doc riak_multi_backend allows you to run multiple backends within a 
 %% single Riak instance. The 'backend' property of a bucket specifies
 %% the backend in which the object should be stored. If no 'backend'
 %% is specified, then the 'multi_backend_default' setting is used.

File apps/riak/src/riak_object.erl

+%% -------------------------------------------------------------------
+%%
+%% riak_object: container for Riak data and metadata
+%%
+%% Copyright (c) 2007-2010 Basho Technologies, Inc.  All Rights Reserved.
+%%
 %% This file is provided to you under the Apache License,
 %% Version 2.0 (the "License"); you may not use this file
 %% except in compliance with the License.  You may obtain
 %% a copy of the License at
-
+%%
 %%   http://www.apache.org/licenses/LICENSE-2.0
-
+%%
 %% Unless required by applicable law or agreed to in writing,
 %% software distributed under the License is distributed on an
 %% "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 %% KIND, either express or implied.  See the License for the
 %% specific language governing permissions and limitations
-%% under the License.    
+%% under the License.
+%%
+%% -------------------------------------------------------------------
 
-%% @doc The container for data stored in Riak.
-%%      
-%%      
+%% @doc container for Riak data and metadata
+
 -module(riak_object).
 -include_lib("eunit/include/eunit.hrl").
 

File apps/riak/src/riak_phase_proto.erl

+%% -------------------------------------------------------------------
+%%
+%% riak_phase_proto: prototype for riak dataflow phases
+%%
+%% Copyright (c) 2007-2010 Basho Technologies, Inc.  All Rights Reserved.
+%%
 %% This file is provided to you under the Apache License,
 %% Version 2.0 (the "License"); you may not use this file
 %% except in compliance with the License.  You may obtain
 %% a copy of the License at
-
+%%
 %%   http://www.apache.org/licenses/LICENSE-2.0
-
+%%
 %% Unless required by applicable law or agreed to in writing,
 %% software distributed under the License is distributed on an
 %% "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 %% KIND, either express or implied.  See the License for the
 %% specific language governing permissions and limitations
 %% under the License.
+%%
+%% -------------------------------------------------------------------
+
+%% @doc prototype for riak dataflow phases
+
 -module(riak_phase_proto).
 
 -export([send_inputs/2, mapexec_result/2, mapexec_error/2, error/2]).

File apps/riak/src/riak_put_fsm.erl

+%% -------------------------------------------------------------------
+%%
+%% riak_put_fsm: coordination of Riak PUT requests
+%%
+%% Copyright (c) 2007-2010 Basho Technologies, Inc.  All Rights Reserved.
+%%
 %% This file is provided to you under the Apache License,
 %% Version 2.0 (the "License"); you may not use this file
 %% except in compliance with the License.  You may obtain
 %% a copy of the License at
-
+%%
 %%   http://www.apache.org/licenses/LICENSE-2.0
-
+%%
 %% Unless required by applicable law or agreed to in writing,
 %% software distributed under the License is distributed on an
 %% "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 %% KIND, either express or implied.  See the License for the
 %% specific language governing permissions and limitations
-%% under the License.    
+%% under the License.
+%%
+%% -------------------------------------------------------------------
+
+%% @doc coordination of Riak PUT requests
 
 -module(riak_put_fsm).
 -include_lib("eunit/include/eunit.hrl").

File apps/riak/src/riak_reduce_phase.erl

+%% -------------------------------------------------------------------
+%%
+%% riak_reduce_phase: manage the mechanics of a reduce phase of a MR job
+%%
+%% Copyright (c) 2007-2010 Basho Technologies, Inc.  All Rights Reserved.
+%%
 %% This file is provided to you under the Apache License,
 %% Version 2.0 (the "License"); you may not use this file
 %% except in compliance with the License.  You may obtain
 %% a copy of the License at
-
+%%
 %%   http://www.apache.org/licenses/LICENSE-2.0
-
+%%
 %% Unless required by applicable law or agreed to in writing,
 %% software distributed under the License is distributed on an
 %% "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 %% KIND, either express or implied.  See the License for the
 %% specific language governing permissions and limitations
 %% under the License.
+%%
+%% -------------------------------------------------------------------
+
+%% @doc manage the mechanics of a reduce phase of a MR job
 
 -module(riak_reduce_phase).
 

File apps/riak/src/riak_ring.erl

+%% -------------------------------------------------------------------
+%%
+%% riak_ring: the datastructure representing a distribution of nodes
+%%
+%% Copyright (c) 2007-2010 Basho Technologies, Inc.  All Rights Reserved.
+%%
 %% This file is provided to you under the Apache License,
 %% Version 2.0 (the "License"); you may not use this file
 %% except in compliance with the License.  You may obtain
 %% a copy of the License at
-
+%%
 %%   http://www.apache.org/licenses/LICENSE-2.0
-
+%%
 %% Unless required by applicable law or agreed to in writing,
 %% software distributed under the License is distributed on an
 %% "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 %% KIND, either express or implied.  See the License for the
 %% specific language governing permissions and limitations
-%% under the License.    
+%% under the License.
+%%
+%% -------------------------------------------------------------------
 
-% @doc riak_ring manages a riak node's local view of partition
-%      ownership.  The functions in this module revolve around use
+%      @doc The functions in this module revolve around use
 %      of the chstate record, which should be treated as opaque by
 %      other modules.  Riak nodes exchange instances of
 %      these records via gossip in order to converge on a common

File apps/riak/src/riak_ring_manager.erl

+%% -------------------------------------------------------------------
+%%
+%% riak_ring_manager: the local view of the cluster's ring configuration
+%%
+%% Copyright (c) 2007-2010 Basho Technologies, Inc.  All Rights Reserved.
+%%
 %% This file is provided to you under the Apache License,
 %% Version 2.0 (the "License"); you may not use this file
 %% except in compliance with the License.  You may obtain
 %% a copy of the License at
-
+%%
 %%   http://www.apache.org/licenses/LICENSE-2.0
-
+%%
 %% Unless required by applicable law or agreed to in writing,
 %% software distributed under the License is distributed on an
 %% "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 %% KIND, either express or implied.  See the License for the
 %% specific language governing permissions and limitations
-%% under the License.    
+%% under the License.
+%%
+%% -------------------------------------------------------------------
 
-%% @doc this owns the local view of the cluster's ring configuration
+%% @doc the local view of the cluster's ring configuration
 
 -module(riak_ring_manager).
 -include_lib("eunit/include/eunit.hrl").

File apps/riak/src/riak_stat.erl

+%% -------------------------------------------------------------------
+%%
+%% riak_stat: collect, aggregate, and provide stats about the local node
+%%
+%% Copyright (c) 2007-2010 Basho Technologies, Inc.  All Rights Reserved.
+%%
 %% This file is provided to you under the Apache License,
 %% Version 2.0 (the "License"); you may not use this file
 %% except in compliance with the License.  You may obtain
 %% a copy of the License at
-
+%%
 %%   http://www.apache.org/licenses/LICENSE-2.0
-
+%%
 %% Unless required by applicable law or agreed to in writing,
 %% software distributed under the License is distributed on an
 %% "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 %% KIND, either express or implied.  See the License for the
 %% specific language governing permissions and limitations
-%% under the License.    
+%% under the License.
+%%
+%% -------------------------------------------------------------------
 
-%% @doc riak_stat is a long-lived gen_server process for aggregating
+%%      @doc riak_stat is a long-lived gen_server process for aggregating
 %%      stats about the Riak node on which it is runing.
 %%
 %%      Update each stat with the exported function update/1.  Modify

File apps/riak/src/riak_sup.erl

+%% -------------------------------------------------------------------
+%%
+%% riak_sup: supervise the core Riak services
+%%
+%% Copyright (c) 2007-2010 Basho Technologies, Inc.  All Rights Reserved.
+%%
 %% This file is provided to you under the Apache License,
 %% Version 2.0 (the "License"); you may not use this file
 %% except in compliance with the License.  You may obtain
 %% a copy of the License at
-
+%%
 %%   http://www.apache.org/licenses/LICENSE-2.0
-
+%%
 %% Unless required by applicable law or agreed to in writing,
 %% software distributed under the License is distributed on an
 %% "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 %% KIND, either express or implied.  See the License for the
 %% specific language governing permissions and limitations
 %% under the License.
+%%
+%% -------------------------------------------------------------------
+
+%% @doc supervise the core Riak services
 
 -module(riak_sup).
 

File apps/riak/src/riak_test_util.erl

+%% -------------------------------------------------------------------
+%%
+%% riak_test_util: utilities for test scripts
+%%
+%% Copyright (c) 2007-2010 Basho Technologies, Inc.  All Rights Reserved.
+%%
+%% This file is provided to you under the Apache License,
+%% Version 2.0 (the "License"); you may not use this file
+%% except in compliance with the License.  You may obtain
+%% a copy of the License at
+%%
+%%   http://www.apache.org/licenses/LICENSE-2.0
+%%
+%% Unless required by applicable law or agreed to in writing,
+%% software distributed under the License is distributed on an
+%% "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+%% KIND, either express or implied.  See the License for the
+%% specific language governing permissions and limitations
+%% under the License.
+%%
+%% -------------------------------------------------------------------
+
+%% @doc utilities for test scripts
+
 -module(riak_test_util).
 -export([standard_backend_test/2,setup_mockring1/0]).
 -include_lib("eunit/include/eunit.hrl").

File apps/riak/src/riak_util.erl

+%% -------------------------------------------------------------------
+%%
+%% riak_util: functions that are useful throughout Riak
+%%
+%% Copyright (c) 2007-2010 Basho Technologies, Inc.  All Rights Reserved.
+%%
 %% This file is provided to you under the Apache License,
 %% Version 2.0 (the "License"); you may not use this file
 %% except in compliance with the License.  You may obtain
 %% a copy of the License at
-
+%%
 %%   http://www.apache.org/licenses/LICENSE-2.0
-
+%%
 %% Unless required by applicable law or agreed to in writing,
 %% software distributed under the License is distributed on an
 %% "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 %% KIND, either express or implied.  See the License for the
 %% specific language governing permissions and limitations
-%% under the License.    
+%% under the License.
+%%
+%% -------------------------------------------------------------------
 
-%% @doc Various functions that are useful throughout Riak.
+%% @doc functions that are useful throughout Riak
+
 -module(riak_util).
 -include_lib("eunit/include/eunit.hrl").
 

File apps/riak/src/riak_vnode.erl

+%% -------------------------------------------------------------------
+%%
+%% riak_vnode: a single node's management of a single partition of data
+%%
+%% Copyright (c) 2007-2010 Basho Technologies, Inc.  All Rights Reserved.
+%%
 %% This file is provided to you under the Apache License,
 %% Version 2.0 (the "License"); you may not use this file
 %% except in compliance with the License.  You may obtain
 %% a copy of the License at
-
+%%
 %%   http://www.apache.org/licenses/LICENSE-2.0
-
+%%
 %% Unless required by applicable law or agreed to in writing,
 %% software distributed under the License is distributed on an
 %% "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 %% KIND, either express or implied.  See the License for the
 %% specific language governing permissions and limitations
 %% under the License.
+%%
+%% -------------------------------------------------------------------
+
+%% @doc a single node's management of a single partition of data
 
 -module(riak_vnode).
 -behaviour(gen_fsm).

File apps/riak/src/riak_vnode_master.erl

- %% This file is provided to you under the Apache License,
+%% -------------------------------------------------------------------
+%%
+%% riak_vnode_master: dispatch to vnodes
+%%
+%% Copyright (c) 2007-2010 Basho Technologies, Inc.  All Rights Reserved.
+%%
+%% This file is provided to you under the Apache License,
 %% Version 2.0 (the "License"); you may not use this file
 %% except in compliance with the License.  You may obtain
 %% a copy of the License at
-
+%%
 %%   http://www.apache.org/licenses/LICENSE-2.0
-
+%%
 %% Unless required by applicable law or agreed to in writing,
 %% software distributed under the License is distributed on an
 %% "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 %% KIND, either express or implied.  See the License for the
 %% specific language governing permissions and limitations
 %% under the License.
+%%
+%% -------------------------------------------------------------------
+
+%% @doc dispatch to vnodes
 
 -module(riak_vnode_master).
 

File apps/riak/src/riak_vnode_sup.erl

+%% -------------------------------------------------------------------
+%%
+%% riak_vnode_sup: supervise riak_vnode processes
+%%
+%% Copyright (c) 2007-2010 Basho Technologies, Inc.  All Rights Reserved.
+%%
 %% This file is provided to you under the Apache License,
 %% Version 2.0 (the "License"); you may not use this file
 %% except in compliance with the License.  You may obtain
 %% a copy of the License at
-
+%%
 %%   http://www.apache.org/licenses/LICENSE-2.0
-
+%%
 %% Unless required by applicable law or agreed to in writing,
 %% software distributed under the License is distributed on an
 %% "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 %% KIND, either express or implied.  See the License for the
 %% specific language governing permissions and limitations
-%% under the License.    
+%% under the License.
+%%
+%% -------------------------------------------------------------------
+
+%% @doc supervise riak_vnode processes
+
 -module(riak_vnode_sup).
 -behaviour(supervisor).
 -export([start_link/0, init/1, stop/1]).

File apps/riak/src/riak_web.erl

+%% -------------------------------------------------------------------
+%%
+%% riak_web: setup Riak's HTTP interface
+%%
+%% Copyright (c) 2007-2010 Basho Technologies, Inc.  All Rights Reserved.
+%%
 %% This file is provided to you under the Apache License,
 %% Version 2.0 (the "License"); you may not use this file
 %% except in compliance with the License.  You may obtain
 %% a copy of the License at
-
+%%
 %%   http://www.apache.org/licenses/LICENSE-2.0
-
+%%
 %% Unless required by applicable law or agreed to in writing,
 %% software distributed under the License is distributed on an
 %% "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 %% KIND, either express or implied.  See the License for the
 %% specific language governing permissions and limitations
 %% under the License.
+%%
+%% -------------------------------------------------------------------
 
-%% @doc Convenience functions for setting up the HTTP interface
-%%      of Riak.  This module loads parameters from the application
-%%      environment:
+%%      This module loads parameters from the application environment:
 %%
 %%<dl><dt>  riak_web_ip
 %%</dt><dd>   IP address that the Webmachine node should listen to
 %%</dt><dd>   the base path under which the raw_http_resource
 %%            should be exposed; defaulted to "raw"
 %%</dd></dl>
+
+%% @doc setup Riak's HTTP interface
+
 -module(riak_web).
 
 -export([config/0]).

File apps/riak/src/slide.erl

+%% -------------------------------------------------------------------
+%%
+%% slide: collected aggregation in sliding time windows
+%%
+%% Copyright (c) 2007-2010 Basho Technologies, Inc.  All Rights Reserved.
+%%
 %% This file is provided to you under the Apache License,
 %% Version 2.0 (the "License"); you may not use this file
 %% except in compliance with the License.  You may obtain
 %% a copy of the License at
-
+%%
 %%   http://www.apache.org/licenses/LICENSE-2.0
-
+%%
 %% Unless required by applicable law or agreed to in writing,
 %% software distributed under the License is distributed on an
 %% "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 %% KIND, either express or implied.  See the License for the
 %% specific language governing permissions and limitations
-%% under the License.    
+%% under the License.
+%%
+%% -------------------------------------------------------------------
 
-%% @doc Keep track of thing in a sliding time window.  The idea here
+%%      @doc Keep track of thing in a sliding time window.  The idea here
 %%      is that you have some reading to take several times.
 %%      Occasionally, you want to compute some aggregation of those
 %%      readings for the last N seconds.

File apps/riak/src/spiraltime.erl

+%% -------------------------------------------------------------------
+%%
+%% spiraltime: sliding windows for recording N-per-interval running stats
+%%
+%% Copyright (c) 2007-2010 Basho Technologies, Inc.  All Rights Reserved.
+%%
 %% This file is provided to you under the Apache License,
 %% Version 2.0 (the "License"); you may not use this file
 %% except in compliance with the License.  You may obtain
 %% a copy of the License at
-
+%%
 %%   http://www.apache.org/licenses/LICENSE-2.0
-
+%%
 %% Unless required by applicable law or agreed to in writing,
 %% software distributed under the License is distributed on an
 %% "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 %% KIND, either express or implied.  See the License for the
 %% specific language governing permissions and limitations
-%% under the License.    
+%% under the License.
+%%
+%% -------------------------------------------------------------------
 
-%% @author Justin Sheehy <justin@basho.com>
-
-%% @doc A set of sliding windows for recording N-per-second running stats.
-%%
-%% This keeps stats per second for the last minute, per minute for an hour,
+%% @doc This keeps stats per second for the last minute, per minute for an hour,
 %% per hour for a day, and per day for a week.
 %%
 %% The goal is not to have "perfect" stats; post-fact log analysis is

File apps/riak/src/stats_http_resource.erl

+%% -------------------------------------------------------------------
+%%
+%% stats_http_resource: publishing Riak runtime stats via HTTP
+%%
+%% Copyright (c) 2007-2010 Basho Technologies, Inc.  All Rights Reserved.
+%%
 %% This file is provided to you under the Apache License,
 %% Version 2.0 (the "License"); you may not use this file
 %% except in compliance with the License.  You may obtain
 %% a copy of the License at
-
+%%
 %%   http://www.apache.org/licenses/LICENSE-2.0
-
+%%
 %% Unless required by applicable law or agreed to in writing,
 %% software distributed under the License is distributed on an
 %% "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 %% KIND, either express or implied.  See the License for the
 %% specific language governing permissions and limitations
 %% under the License.
+%%
+%% -------------------------------------------------------------------
 
 -module(stats_http_resource).
 -author('Andy Gross <andy@basho.com>').

File apps/riak/src/vclock.erl

-%% @copyright 2007-2008 Basho Technologies
+%% -------------------------------------------------------------------
+%%
+%% vclock: vector clocks as inspired by Lamport and Mattern
+%%
+%% Copyright (c) 2007-2010 Basho Technologies, Inc.  All Rights Reserved.