improved documentation

ypaq · Sep 11, 2010 · 7d00230 · 7d00230
1 parent 249aeb2
commit 7d00230
Show file tree

Hide file tree

Showing 7 changed files with 7 additions and 5 deletions.
diff --git a/doc/cferl.png → cferl.png b/doc/cferl.png → cferl.png
diff --git a/doc/cferl.xcf → cferl.xcf b/doc/cferl.xcf → cferl.xcf
diff --git a/doc/overview.edoc b/doc/overview.edoc
@@ -1,4 +1,6 @@
 @title cferl
-@doc <center><img src="cferl.png"/><br/><br/><h1>Rackspace Cloud Files Erlang Client</h1></center>
+@doc <center><img src="../cferl.png"/><br/><br/>
+<h1>Rackspace Cloud Files Erlang Client</h1></center>
+<p>Read the project's <a href="http://github.com/ddossot/cferl/blob/master/README.md">README file</a> for more information.</p>
 @author David Dossot <[email protected]>
 @copyright 2010 David Dossot
diff --git a/src/cferl.erl b/src/cferl.erl
@@ -1,5 +1,5 @@
 %%%
-%%% @doc Rackspace Cloud Files Erlang Client
+%%% @doc Authentication and connection with Rackspace Cloud Files.
 %%% @author David Dossot <[email protected]>
 %%%
 %%% See LICENSE for license information.

diff --git a/src/cferl_connection.erl b/src/cferl_connection.erl
@@ -1,5 +1,5 @@
 %%%
-%%% @doc Rackspace Cloud Files Erlang Client
+%%% @doc Management of an account's containers.
 %%% @author David Dossot <[email protected]>
 %%%
 %%% See LICENSE for license information.

diff --git a/src/cferl_container.erl b/src/cferl_container.erl
@@ -1,5 +1,5 @@
 %%%
-%%% @doc Rackspace Cloud Files Erlang Client
+%%% @doc Management of a container's storage objects.
 %%% @author David Dossot <[email protected]>
 %%%
 %%% See LICENSE for license information.

diff --git a/src/cferl_object.erl b/src/cferl_object.erl
@@ -1,5 +1,5 @@
 %%%
-%%% @doc Rackspace Cloud Files Erlang Client
+%%% @doc Handling of a single storage object.
 %%% @author David Dossot <[email protected]>
 %%%
 %%% See LICENSE for license information.