Martchus
/
tagparser
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Improve documentation

This commit is contained in:
Martchus 2016-12-27 23:40:36 +01:00
parent 369a241131
commit 6a5b4eb4a0
2 changed files with 6 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
fieldbasedtag.h
View File

@ -142,6 +142,8 @@ bool FieldMapBasedTag<FieldType, Compare>::setValue(const typename FieldType::id
/*!
* \brief Assigns the given \a values to the field with the specified \a id.
* \remarks There might me more then one value assigned to an \a id. Whereas setValue() only alters the first value, this
* method will replace all currently assigned values with the specified \a values.
* \sa Tag::setValues()
*/
template <class FieldType, class Compare>
@ -168,6 +170,7 @@ bool FieldMapBasedTag<FieldType, Compare>::setValues(const typename FieldType::i
* \brief Assigns the given \a values to the field with the specified \a id.
* \remarks There might me more then one value assigned to a \a field. Whereas setValue() only alters the first value, this
* method will replace all currently assigned values with the specified \a values.
* \sa Tag::setValues()
*/
template <class FieldType, class Compare>
bool FieldMapBasedTag<FieldType, Compare>::setValues(KnownField field, const std::vector<TagValue> &values)

6
ogg/oggiterator.cpp
View File

@ -37,7 +37,7 @@ void OggIterator::clear(istream &stream, uint64 startOffset, uint64 streamSize)
* \brief Resets the iterator to point at the first segment of the first page (matching the filter if set).
*
* Fetched pages (directly accessable through the page() method) remain after resetting the iterator. Use
* the clear method to clear all pages.
* clear() to clear all pages.
*/
void OggIterator::reset()
{
@ -131,7 +131,7 @@ void OggIterator::read(char *buffer, size_t count)
{
size_t bytesRead = 0;
while(*this && count) {
uint32 available = currentSegmentSize() - m_bytesRead;
const uint32 available = currentSegmentSize() - m_bytesRead;
stream().seekg(currentCharacterOffset());
if(count <= available) {
stream().read(buffer + bytesRead, count);
@ -164,7 +164,7 @@ size_t OggIterator::readAll(char *buffer, size_t max)
{
size_t bytesRead = 0;
while(*this && max) {
uint32 available = currentSegmentSize() - m_bytesRead;
const uint32 available = currentSegmentSize() - m_bytesRead;
stream().seekg(currentCharacterOffset());
if(max <= available) {
stream().read(buffer + bytesRead, max);