From ec961f26e963248b5db273b938d44afad3a22b66 Mon Sep 17 00:00:00 2001 From: Max Kellermann Date: Mon, 14 Feb 2022 13:27:49 +0100 Subject: [PATCH] song/DetachedSong: add API docs --- src/song/DetachedSong.hxx | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/src/song/DetachedSong.hxx b/src/song/DetachedSong.hxx index 0cdebd7c9..bffa0e7b4 100644 --- a/src/song/DetachedSong.hxx +++ b/src/song/DetachedSong.hxx @@ -32,6 +32,12 @@ struct LightSong; class Storage; 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 { friend DetachedSong DatabaseDetachSong(const Storage &db, const LightSong &song);