Cutlery/calibre
1
0
Fork 0
mirror of https://github.com/kovidgoyal/calibre.git synced 2025-07-09 03:04:10 -04:00
Code Issues Packages Projects Releases Wiki Activity

Updated apidocs

Browse Source
This commit is contained in:
Kovid Goyal 2007-01-13 17:48:44 +00:00
parent 3fc53270b5
commit 0be8846706
4 changed files with 15 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
Makefile
View File

@ -1,4 +1,4 @@
APIDOCS=/var/www/libprs500.kovidgoyal.net//htdocs/apidocs APIDOCS=/var/www/libprs500.kovidgoyal.net/htdocs/apidocs
all: doc sdist egg all: doc sdist egg

4
epydoc-pdf.conf
View File

@ -7,7 +7,7 @@ url: http://libprs500.kovidgoyal.net
# The list of modules to document. Modules can be named using # The list of modules to document. Modules can be named using
# dotted names, module filenames, or package directory names. # dotted names, module filenames, or package directory names.
# This option may be repeated. # This option may be repeated.
modules: libprs500/*.py, libprs500.lrf, usb, struct modules: src/libprs500/*.py, libprs500.lrf, struct
output: pdf output: pdf
target: docs/pdf target: docs/pdf
@ -36,7 +36,7 @@ css: white
# The "top" page for the documentation. Can be a URL, the name # 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", # of a module or class, or one of the special names "trees.html",
# "indices.html", or "help.html" # "indices.html", or "help.html"
top: libprs500 # top: libprs500
# verbosity # verbosity
# An integer indicating how verbose epydoc should be. The default # An integer indicating how verbose epydoc should be. The default

6
epydoc.conf
View File

@ -7,9 +7,9 @@ url: http://libprs500.kovidgoyal.net
# The list of modules to document. Modules can be named using # The list of modules to document. Modules can be named using
# dotted names, module filenames, or package directory names. # dotted names, module filenames, or package directory names.
# This option may be repeated. # 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 output: html
target: docs/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 # 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", # of a module or class, or one of the special names "trees.html",
# "indices.html", or "help.html" # "indices.html", or "help.html"
top: libprs500 #top:
# verbosity # verbosity
# An integer indicating how verbose epydoc should be. The default # An integer indicating how verbose epydoc should be. The default

22
src/libprs500/communicate.py
View File

@ -120,11 +120,7 @@ class PRS500Device(Device):
""" """
Contains the logic for performing various tasks on the reader. Contains the logic for performing various tasks on the reader.
Each method decorated by C{safe} performs a task.
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.
""" """
VENDOR_ID = 0x054c #: SONY Vendor Id VENDOR_ID = 0x054c #: SONY Vendor Id
@ -537,9 +533,9 @@ class PRS500Device(Device):
def total_space(self, end_session=True): def total_space(self, end_session=True):
""" """
Get total space available on the mountpoints: Get total space available on the mountpoints:
1. Main memory 1. Main memory
2. Memory Stick 2. Memory Stick
3. SD Card 3. SD Card
@return: A 3 element list with total space in bytes of (1, 2, 3) @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): def free_space(self, end_session=True):
""" """
Get free space available on the mountpoints: Get free space available on the mountpoints:
1. Main memory 1. Main memory
2. Memory Stick 2. Memory Stick
3. SD Card 3. SD Card
@return: A 3 element list with free space in bytes of (1, 2, 3) @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 device. The extension of name must be one of
the supported formats for this device. the supported formats for this device.
@param info: A dictionary that must have the keys "title", "authors", "cover". @param info: A dictionary that must have the keys "title", "authors", "cover".
C{info["cover"]} should be a three element tuple (width, height, data) C{info["cover"]} should be a three element tuple (width, height, data)
where data is the image data in JPEG format as a string where data is the image data in JPEG format as a string
@param booklists: A tuple containing the result of calls to @param booklists: A tuple containing the result of calls to
(L{books}(oncard=False), L{books}(oncard=True)). (L{books}(oncard=False), L{books}(oncard=True)).
""" """