song/DetachedSong: add API docs

This commit is contained in:
Max Kellermann 2022-02-14 13:27:49 +01:00
parent c3be961ccf
commit ec961f26e9
1 changed files with 6 additions and 0 deletions

View File

@ -32,6 +32,12 @@ struct LightSong;
class Storage; class Storage;
class Path; class Path;
/**
* A stand-alone description of a song, that is, it manages all
* pointers. It is called "detached" because it is usually a copy of
* a #Song (or #LightSong) instance that was detached from the
* database.
*/
class DetachedSong { class DetachedSong {
friend DetachedSong DatabaseDetachSong(const Storage &db, friend DetachedSong DatabaseDetachSong(const Storage &db,
const LightSong &song); const LightSong &song);