Improve API doc

This commit is contained in:
Martchus 2016-06-15 22:53:39 +02:00
parent cf5b021180
commit 7e058f289c
5 changed files with 9 additions and 4 deletions

View File

@ -493,7 +493,7 @@ inline const typename GenericFileElement<ImplementationType>::implementationType
* \brief Returns the first child of the element.
*
* The current element keeps ownership over the returned element.
* If childs are present nullptr is returned.
* If no childs are present nullptr is returned.
*
* \remarks parse() needs to be called before.
*/
@ -507,7 +507,7 @@ inline typename GenericFileElement<ImplementationType>::implementationType *Gene
* \brief Returns the first child of the element.
*
* The current element keeps ownership over the returned element.
* If childs are present nullptr is returned.
* If no childs are present nullptr is returned.
*
* \remarks parse() needs to be called before.
*/

View File

@ -770,6 +770,7 @@ void Id3v2Frame::parseComment(const char *buffer, std::size_t dataSize, TagValue
/*!
* \brief Writes an encoding denoation and the specified string \a value to a \a buffer.
* \param buffer Specifies the buffer.
* \param bufferSize Specifies the size of \a buffer.
* \param value Specifies the string to make.
* \param encoding Specifies the encoding of the string to make.
*/

View File

@ -25,7 +25,7 @@ class AbstractTrack;
class VorbisComment;
enum class MediaType;
enum class TagType : unsigned int;
DECLARE_ENUM(TagType, unsigned int);
/*!
* \brief The TagUsage enum specifies the usage of a certain tag type.

View File

@ -8,7 +8,7 @@
namespace Media {
enum class TagTargetLevel : byte;
DECLARE_ENUM(TagTargetLevel, byte);
/*!
* \brief Specifies the container format.

View File

@ -36,6 +36,10 @@ enum class TagStatus
Removed
};
/*!
* \brief The OverallTests class tests reading and writing tags and parsing technical information
* for all supported container/tag formats.
*/
class OverallTests : public TestFixture
{
CPPUNIT_TEST_SUITE(OverallTests);