From 0b47186e57bfdfc6f0b13ac060e7ef6226f33d98 Mon Sep 17 00:00:00 2001 From: Martchus Date: Mon, 16 Aug 2021 18:44:28 +0200 Subject: [PATCH] Deprecate certain unused Ogg functions which are likely not generally useful --- ogg/oggiterator.cpp | 1 + ogg/oggiterator.h | 1 + ogg/oggpage.cpp | 2 ++ 3 files changed, 4 insertions(+) diff --git a/ogg/oggiterator.cpp b/ogg/oggiterator.cpp index c6c8ec3..74cd0d9 100644 --- a/ogg/oggiterator.cpp +++ b/ogg/oggiterator.cpp @@ -164,6 +164,7 @@ void OggIterator::read(char *buffer, std::size_t count) * \sa read() * \sa currentCharacterOffset() * \sa seekForward() + * \deprecated Remove this unused function in v11. */ std::size_t OggIterator::readAll(char *buffer, std::size_t max) { diff --git a/ogg/oggiterator.h b/ogg/oggiterator.h index e8b1b1a..124b150 100644 --- a/ogg/oggiterator.h +++ b/ogg/oggiterator.h @@ -291,6 +291,7 @@ inline bool OggIterator::isLastPageFetched() const /*! * \brief Returns whether there are \a atLeast bytes remaining. + * \deprecated Remove this unused function in v11. */ inline bool OggIterator::bytesRemaining(size_t atLeast) const { diff --git a/ogg/oggpage.cpp b/ogg/oggpage.cpp index 32eb404..68dcb6e 100644 --- a/ogg/oggpage.cpp +++ b/ogg/oggpage.cpp @@ -16,6 +16,7 @@ namespace TagParser { * \class TagParser::OggPage * \brief The OggPage class is used to parse OGG pages. * \sa http://www.xiph.org/ogg/doc/framing.html + * \todo Add field for additional flags in v11. */ /*! @@ -123,6 +124,7 @@ void OggPage::updateChecksum(iostream &stream, std::uint64_t startOffset) /*! * \brief Writes the segment size denotation for the specified segment \a size to the specified stream. * \return Returns the number of bytes written. + * \deprecated This function is unused and should be removed in v11. */ std::uint32_t OggPage::makeSegmentSizeDenotation(ostream &stream, std::uint32_t size) {