Deprecate certain unused Ogg functions which are likely not generally useful

This commit is contained in:
Martchus 2021-08-16 18:44:28 +02:00
parent 932687f93d
commit 0b47186e57
3 changed files with 4 additions and 0 deletions

View File

@ -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)
{

View File

@ -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
{

View File

@ -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)
{