From 5ee230352df6d06cdba6f48da3d83a608847785c Mon Sep 17 00:00:00 2001 From: Detlev Casanova Date: Fri, 16 Jul 2010 22:52:58 +0200 Subject: Add comment to newly added functions --- src/laymanapi.c | 23 ++++++++++++++++++++++- 1 file changed, 22 insertions(+), 1 deletion(-) diff --git a/src/laymanapi.c b/src/laymanapi.c index 9048921..8458c38 100644 --- a/src/laymanapi.c +++ b/src/laymanapi.c @@ -389,13 +389,19 @@ int _laymanAPIGetAllInfos(LaymanAPI* l, StringList* overlays, OverlayInfo *resul k++; } - + + //The returned value is not necessary anymore. Py_DECREF(obj); //Return the number of structures that have been filled. return k; } +/* + * Adds an overlay to layman + * + * Return True if it succeeded, False if not + */ int laymanAPIAddRepo(LaymanAPI* l, const char *repo) { if (!l || !l->object || !repo) @@ -416,6 +422,11 @@ int laymanAPIAddRepo(LaymanAPI* l, const char *repo) return ret; } +/* + * Adds a list of overlays to layman + * + * Return True if it succeeded, False if not + */ int laymanAPIAddRepos(LaymanAPI* l, StringList *repos) { if (!l || !l->object || !repos) @@ -440,6 +451,11 @@ int laymanAPIAddRepos(LaymanAPI* l, StringList *repos) return ret; } +/* + * Deletes an overlay from layman + * + * Return True if it succeeded, False if not + */ int laymanAPIDeleteRepo(LaymanAPI* l, const char *repo) { if (!l || !l->object || !repo) @@ -460,6 +476,11 @@ int laymanAPIDeleteRepo(LaymanAPI* l, const char *repo) return ret; } +/* + * Deletes a list of overlays from layman + * + * Return True if it succeeded, False if not + */ int laymanAPIDeleteRepos(LaymanAPI* l, StringList *repos) { if (!l || !l->object || !repos) -- cgit v1.2.3-1-g7c22