summaryrefslogtreecommitdiff
path: root/drivers/media
diff options
context:
space:
mode:
authorMauro Carvalho Chehab <mchehab@s-opensource.com>2016-07-20 09:22:38 -0300
committerMauro Carvalho Chehab <mchehab@s-opensource.com>2016-07-23 08:03:24 -0300
commit5b8700e9f909d8fb2802d7ea2626460d3a233256 (patch)
tree49679271ed1cb7ec658f70def8b468bdef7ddf96 /drivers/media
parentc278256d05a2fc75b427fa6a5dc0024faa93465d (diff)
[media] doc-rst: Fix some Sphinx warnings
Fix all remaining media warnings with ReST that are fixable without changing at the Sphinx code. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
Diffstat (limited to 'drivers/media')
-rw-r--r--drivers/media/dvb-core/dvb_math.h7
1 files changed, 7 insertions, 0 deletions
diff --git a/drivers/media/dvb-core/dvb_math.h b/drivers/media/dvb-core/dvb_math.h
index 34dc1df03cab..2f0326674ca6 100644
--- a/drivers/media/dvb-core/dvb_math.h
+++ b/drivers/media/dvb-core/dvb_math.h
@@ -30,11 +30,15 @@
* @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
*
* Some usecase examples:
+ *
* intlog2(8) will give 3 << 24 = 3 * 2^24
+ *
* intlog2(9) will give 3 << 24 + ... = 3.16... * 2^24
+ *
* intlog2(1.5) = intlog2(3) - 2^24 = 0.584... * 2^24
*
*
@@ -48,10 +52,13 @@ extern unsigned int intlog2(u32 value);
* @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
*
* An usecase example:
+ *
* intlog10(1000) will give 3 << 24 = 3 * 2^24
+ *
* due to the implementation intlog10(1000) might be not exactly 3 * 2^24
*
* look at intlog2 for similar examples