Improve the developer API documentation

Improve the code documentation (still much more to do) and also add some
more meat to the structure of the developer documentation.

Signed-off-by: Sebastian Spaeth <Sebastian@SSpaeth.de>
Signed-off-by: Nicolas Sebrecht <nicolas.s-dev@laposte.net>
This commit is contained in:
Sebastian Spaeth
2011-05-02 17:11:40 +02:00
committed by Nicolas Sebrecht
parent e9a7afda6d
commit 6add201436
8 changed files with 153 additions and 45 deletions

View File

@ -41,9 +41,10 @@ lockfd = None
class OfflineImap:
"""The main class that encapsulates the high level use of OfflineImap.
To invoke OfflineImap you would call it with:
oi = OfflineImap()
oi.run()
To invoke OfflineImap you would call it with::
oi = OfflineImap()
oi.run()
"""
def lock(self, config, ui):
global lockfd, hasfcntl