diff options
| author |   Jose Bollo <jose.bollo@iot.bzh> | 2019-09-30 17:40:04 +0200 |
|---|---|---|
| committer | José Bollo <jose.bollo@iot.bzh> | 2019-10-03 12:35:01 +0200 |
| commit | f161cd8b8b83a29f42c275fe31a96825a8d27d86 (patch) | |
| tree | f13aaf40ea67fe0c4459a283dd0773a00752c740 /src/filedb.h | |
| parent | 6bf1b8c3a8af299c04d9be0d59b42c3a6d7c9127 (diff) | |
Improve comments
Signed-off-by: Jose Bollo <jose.bollo@iot.bzh>
Diffstat (limited to 'src/filedb.h')
| -rw-r--r-- | src/filedb.h | 15 |
1 files changed, 12 insertions, 3 deletions
diff --git a/src/filedb.h b/src/filedb.h index d575e50..85d6c26 100644 --- a/src/filedb.h +++ b/src/filedb.h @@ -14,11 +14,20 @@ * See the License for the specific language governing permissions and * limitations under the License. */ - #pragma once +/******************************************************************************/ +/******************************************************************************/ +/* IMPLEMENTATION OF DATABASE WITH FILE BACKEND */ +/******************************************************************************/ +/******************************************************************************/ - -/** is the database empty */ +/** + * Create the object handling the file database + * @param filedb pointer to the handling object to return + * @param directory the directory of the database + * @param basename the basename of the database + * @return 0 in case of success with *filedb fulfilled or negative -errno error + */ int filedb_create( anydb_t **filedb, |