diff options
| author | Mauro Carvalho Chehab <mchehab@osg.samsung.com> | 2015-08-22 13:37:28 +0300 |
|---|---|---|
| committer | Mauro Carvalho Chehab <mchehab@osg.samsung.com> | 2015-08-22 15:05:40 +0300 |
| commit | e08bb6f79fa0b9bf94ea44a306d1528172d788af (patch) | |
| tree | dca13c3a4c2bf9460f02e62a353bebbd545d4ac1 | |
| parent | 4f1c1868e8d4e493d66b8e11eebbc95abdbaf444 (diff) | |
| download | linux-e08bb6f79fa0b9bf94ea44a306d1528172d788af.tar.xz | |
[media] DocBook: add dvb_math.h to documentation
There are already some comments at dvb_math.h that are ready
for DocBook, although not properly formatted.
Convert them, fix some issues and add this file to
the device-drivers DocBook.
Signed-off-by: Mauro Carvalho Chehab <mchehab@osg.samsung.com>
Acked-by: Jonathan Corbet <corbet@lwn.net>
| -rw-r--r-- | Documentation/DocBook/device-drivers.tmpl | 2 | ||||
| -rw-r--r-- | drivers/media/dvb-core/dvb_math.h | 15 |
2 files changed, 10 insertions, 7 deletions
diff --git a/Documentation/DocBook/device-drivers.tmpl b/Documentation/DocBook/device-drivers.tmpl index fb5c16a24e4b..21fc7684d706 100644 --- a/Documentation/DocBook/device-drivers.tmpl +++ b/Documentation/DocBook/device-drivers.tmpl @@ -229,6 +229,7 @@ X!Isound/sound_firmware.c !Iinclude/media/rc-core.h !Idrivers/media/dvb-core/dvb_ca_en50221.h !Idrivers/media/dvb-core/dvb_frontend.h +!Idrivers/media/dvb-core/dvb_math.h <!-- FIXME: Removed for now due to document generation inconsistency X!Iinclude/media/v4l2-ctrls.h X!Iinclude/media/v4l2-dv-timings.h @@ -241,7 +242,6 @@ X!Edrivers/media/dvb-core/dvb_demux.c X!Idrivers/media/dvb-core/dvbdev.h X!Edrivers/media/dvb-core/dvb_net.c X!Idrivers/media/dvb-core/dvb_ringbuffer.h -X!Idrivers/media/dvb-core/dvb_math.h --> </chapter> diff --git a/drivers/media/dvb-core/dvb_math.h b/drivers/media/dvb-core/dvb_math.h index f586aa001ede..34dc1df03cab 100644 --- a/drivers/media/dvb-core/dvb_math.h +++ b/drivers/media/dvb-core/dvb_math.h @@ -25,7 +25,9 @@ #include <linux/types.h> /** - * computes log2 of a value; the result is shifted left by 24 bits + * cintlog2 - computes log2 of a value; the result is shifted left by 24 bits + * + * @value: The value (must be != 0) * * to use rational values you can use the following method: * intlog2(value) = intlog2(value * 2^x) - x * 2^24 @@ -35,13 +37,15 @@ * intlog2(9) will give 3 << 24 + ... = 3.16... * 2^24 * intlog2(1.5) = intlog2(3) - 2^24 = 0.584... * 2^24 * - * @param value The value (must be != 0) - * @return log2(value) * 2^24 + * + * return: log2(value) * 2^24 */ extern unsigned int intlog2(u32 value); /** - * computes log10 of a value; the result is shifted left by 24 bits + * intlog10 - computes log10 of a value; the result is shifted left by 24 bits + * + * @value: The value (must be != 0) * * to use rational values you can use the following method: * intlog10(value) = intlog10(value * 10^x) - x * 2^24 @@ -52,8 +56,7 @@ extern unsigned int intlog2(u32 value); * * look at intlog2 for similar examples * - * @param value The value (must be != 0) - * @return log10(value) * 2^24 + * return: log10(value) * 2^24 */ extern unsigned int intlog10(u32 value); |