Skip to content

Commit b3a4df9

Browse files
Improved comments
1 parent cb393d8 commit b3a4df9

File tree

1 file changed

+6
-2
lines changed

1 file changed

+6
-2
lines changed

src/application/interfaces/utility/i_book_getter.hpp

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,11 @@ namespace application
77
{
88

99
/**
10-
* This is a basic interface to get a pointer to a book from any source.
10+
* This is an interface to get a pointer to a book from any source, either the
11+
* in-memory library or the file system. We need this because the book service
12+
* needs to access the book to add highlights, bookmarks, etc. But it doesn't
13+
* know if the book is in the library or on the file system (in the case of an
14+
* external book). So it uses this interface to get a book pointer.
1115
*/
1216
class APPLICATION_EXPORT IBookGetter
1317
{
@@ -20,4 +24,4 @@ class APPLICATION_EXPORT IBookGetter
2024
virtual bool bookIsValid() = 0;
2125
};
2226

23-
} // namespace application
27+
} // namespace application

0 commit comments

Comments
 (0)