diff --git a/core/library.cpp b/core/library.cpp index 1609e65e..289c4f3d 100644 --- a/core/library.cpp +++ b/core/library.cpp @@ -1,4 +1,5 @@ -/* +/** + * @file * Copyright 2013 (c) Anna Schumaker. */ #include diff --git a/include/core/library.h b/include/core/library.h index 2c0a0b2c..08bf8074 100644 --- a/include/core/library.h +++ b/include/core/library.h @@ -1,4 +1,5 @@ -/* +/** + * @file * Copyright 2013 (c) Anna Schumaker. */ #ifndef OCARINA_CORE_LIBRARY_H @@ -8,17 +9,59 @@ #include #include + +/** + * Namespace for library access. + */ namespace library { + /** + * Initialize the library queue with all the tracks in the tagdb. + */ void init(); + /** + * Add a new directory to the library. + * + * @param dir The directory that should be scanned. + * @return The newly created library object. + */ Library *add(const std::string &); + + /** + * Remove a library from the database. + * + * @param library The library path that should be removed. + */ void remove(Library *); + + /** + * Update a specific library path. + * + * @param library The library path that should be updated. + */ void update(Library *); + + /** + * Rescan and update all library paths. + */ void update_all(); + /** + * Use to enable or disable a library path. + * + * @param library The library to be enabled or disabled. + * @param enabled Set to true if the library should be enabled, + * and false to disable it. + */ void set_enabled(Library *, bool); + + /** + * Use to access the library queue. + * + * @return The queue of tracks currently in the library. + */ Queue *get_queue(); };