mirror/taglib
1
0
Fork 0
mirror of https://github.com/taglib/taglib.git synced 2026-08-14 06:17:00 -04:00
Code Issues Packages Projects Releases Wiki Activity

docs: Some improvements to the documentation (#1337)

Browse Source 
Make MP4 AtomDataType descriptions visible in the generated documentation.
Convert the ID3v2 text frame listing into a table.
Convert the shorten `fileType()` documentation into a table.
Fix some typos.
Add link to specification in `EventType` for consistency with other headers.
This commit is contained in:
Felipe
2026-04-13 20:05:53 +02:00
committed by GitHub
parent c3a0e1d0a2
commit d466b72eea
7 changed files with 122 additions and 87 deletions
Download Patch File Download Diff File Expand all files Collapse all files
taglib/mpc/mpcproperties.h
+14 -10
View File
@@ -93,28 +93,32 @@ namespace TagLib {
unsigned long sampleFrames() const;
/*!
* Returns the track gain as an integer value,
* to convert to dB: trackGain in dB = 64.82 - (trackGain / 256)
* Returns the track gain as an integer value.
*
* To convert to dB: trackGain in dB = 64.82 - (trackGain / 256)
*/
int trackGain() const;
/*!
* Returns the track peak as an integer value,
* to convert to dB: trackPeak in dB = trackPeak / 256
* to convert to floating [-1..1]: trackPeak = 10^(trackPeak / 256 / 20)/32768
* Returns the track peak as an integer value.
*
* To convert to dB: trackPeak in dB = trackPeak / 256 \n
* To convert to floating [-1..1]: trackPeak = 10^(trackPeak / 256 / 20)/32768
*/
int trackPeak() const;
/*!
* Returns the album gain as an integer value,
* to convert to dB: albumGain in dB = 64.82 - (albumGain / 256)
* Returns the album gain as an integer value.
*
* To convert to dB: albumGain in dB = 64.82 - (albumGain / 256)
*/
int albumGain() const;
/*!
* Returns the album peak as an integer value,
* to convert to dB: albumPeak in dB = albumPeak / 256
* to convert to floating [-1..1]: albumPeak = 10^(albumPeak / 256 / 20)/32768
* Returns the album peak as an integer value.
*
* To convert to dB: albumPeak in dB = albumPeak / 256 \n
* To convert to floating [-1..1]: albumPeak = 10^(albumPeak / 256 / 20)/32768
*/
int albumPeak() const;