From 0be8846706d2ad4fd11208708a54b903afd0421f Mon Sep 17 00:00:00 2001
From: Kovid Goyal <kovid@kovidgoyal.net>
Date: Sat, 13 Jan 2007 17:48:44 +0000
Subject: [PATCH] Updated apidocs

---
 Makefile                     |  2 +-
 epydoc-pdf.conf              |  4 ++--
 epydoc.conf                  |  6 +++---
 src/libprs500/communicate.py | 22 +++++++++-------------
 4 files changed, 15 insertions(+), 19 deletions(-)

diff --git a/Makefile b/Makefile
index 043dda96c2..9fdc37c298 100644
--- a/Makefile
+++ b/Makefile
@@ -1,4 +1,4 @@
-APIDOCS=/var/www/libprs500.kovidgoyal.net//htdocs/apidocs
+APIDOCS=/var/www/libprs500.kovidgoyal.net/htdocs/apidocs
 
 all: doc sdist egg
 
diff --git a/epydoc-pdf.conf b/epydoc-pdf.conf
index d0b07f9698..3ac260f650 100644
--- a/epydoc-pdf.conf
+++ b/epydoc-pdf.conf
@@ -7,7 +7,7 @@ url: http://libprs500.kovidgoyal.net
 # The list of modules to document.  Modules can be named using
 # dotted names, module filenames, or package directory names.
 # This option may be repeated.
-modules: libprs500/*.py, libprs500.lrf, usb, struct
+modules: src/libprs500/*.py, libprs500.lrf, struct
 
 output: pdf
 target: docs/pdf
@@ -36,7 +36,7 @@ css: white
 #   The "top" page for the documentation.  Can be a URL, the name
 #   of a module or class, or one of the special names "trees.html",
 #   "indices.html", or "help.html"
-top: libprs500
+# top: libprs500
 
 # verbosity
 #   An integer indicating how verbose epydoc should be.  The default
diff --git a/epydoc.conf b/epydoc.conf
index 812484fc02..6d8d72c2fa 100644
--- a/epydoc.conf
+++ b/epydoc.conf
@@ -7,9 +7,9 @@ url: http://libprs500.kovidgoyal.net
 # The list of modules to document.  Modules can be named using
 # dotted names, module filenames, or package directory names.
 # This option may be repeated.
-modules: libprs500/*.py, libprs500.lrf, usb, struct
+modules: src/libprs500/*.py, libprs500.lrf, struct
 
-# Write html output to the directory "apidocs"
+# Write html output to the directory "docs"
 output: html
 target: docs/html
 
@@ -37,7 +37,7 @@ link: <a href="http://libprs500.kovidgoyal.net">libprs500</a>
 #   The "top" page for the documentation.  Can be a URL, the name
 #   of a module or class, or one of the special names "trees.html",
 #   "indices.html", or "help.html"
-top: libprs500
+#top: 
 
 # verbosity
 #   An integer indicating how verbose epydoc should be.  The default
diff --git a/src/libprs500/communicate.py b/src/libprs500/communicate.py
index 40131902b2..b71d9fab0a 100755
--- a/src/libprs500/communicate.py
+++ b/src/libprs500/communicate.py
@@ -120,11 +120,7 @@ class PRS500Device(Device):
 
     """
     Contains the logic for performing various tasks on the reader. 
-
-    The implemented tasks are:
-    0. Getting information about the device
-    1. Getting a file from the device
-    2. Listing of directories. See the C{list} method. 
+    Each method decorated by C{safe} performs a task.    
     """
 
     VENDOR_ID      = 0x054c #: SONY Vendor Id
@@ -537,9 +533,9 @@ class PRS500Device(Device):
     def total_space(self, end_session=True):
         """ 
         Get total space available on the mountpoints:
-        1. Main memory
-        2. Memory Stick
-        3. SD Card
+          1. Main memory
+          2. Memory Stick
+          3. SD Card
 
         @return: A 3 element list with total space in bytes of (1, 2, 3)
         """    
@@ -558,9 +554,9 @@ class PRS500Device(Device):
     def free_space(self, end_session=True):
         """ 
         Get free space available on the mountpoints:
-        1. Main memory
-        2. Memory Stick
-        3. SD Card
+          1. Main memory
+          2. Memory Stick
+          3. SD Card
 
         @return: A 3 element list with free space in bytes of (1, 2, 3)
         """    
@@ -763,8 +759,8 @@ class PRS500Device(Device):
                                 device. The extension of name must be one of 
                                 the supported formats for this device.
         @param info: A dictionary that must have the keys "title", "authors", "cover". 
-        C{info["cover"]} should be a three element tuple (width, height, data) 
-                                where data is the image data in JPEG format as a string
+                     C{info["cover"]} should be a three element tuple (width, height, data)
+                     where data is the image data in JPEG format as a string
         @param booklists: A tuple containing the result of calls to 
                                     (L{books}(oncard=False), L{books}(oncard=True)).    
         """