media: dvb/frontend.h: document the uAPI file
authorMauro Carvalho Chehab <mchehab@s-opensource.com>
Fri, 5 Jun 2020 16:25:01 +0000 (09:25 -0700)
committerSasha Levin <sashal@kernel.org>
Tue, 30 Jun 2020 19:38:33 +0000 (15:38 -0400)
commitdc06ae4f1ba3d30b24140e821e1cebf9ed1a66ef
treeb959330b0c50cad9ad3a1fa36e7df7661ed43d0b
parentfb4ffc2662cc3023460e00f3dd9e12b99d929978
media: dvb/frontend.h: document the uAPI file

commit 8220ead805b6bab4ade2839857a198e9708b07de upstream

Most of the stuff at the Digital TV frontend header file
are documented only at the Documentation. However, a few
kernel-doc markups are there, several of them with parsing
issues.

Add the missing documentation, copying definitions from the
Documentation when it applies, fixing some bugs.

Please notice that DVBv3 stuff that were deprecated weren't
commented by purpose. Instead, they were clearly tagged as
such.

This patch prepares to move part of the documentation from
Documentation/ to kernel-doc comments.

Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
Signed-off-by: Florian Fainelli <f.fainelli@gmail.com>
Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
include/uapi/linux/dvb/frontend.h