selftests: kselftest_harness.h: partially fix kernel-doc markups
authorMauro Carvalho Chehab <mchehab+huawei@kernel.org>
Thu, 14 Jan 2021 08:04:46 +0000 (09:04 +0100)
committerJonathan Corbet <corbet@lwn.net>
Thu, 21 Jan 2021 21:06:00 +0000 (14:06 -0700)
commit3950b92f96912cf2578c94a31961296c9680a0f2
tree7309a81e920ef77f8e0e343b8e217931e1cc05dd
parent484cac791015e786f857c1cd98b7696aaf1e8a7a
selftests: kselftest_harness.h: partially fix kernel-doc markups

The kernel-doc markups on this file are weird: they don't
follow what's specified at:

Documentation/doc-guide/kernel-doc.rst

In particular, markups should use this format:
        identifier - description

and not this:
identifier(args)

The way the definitions are inside this file cause the
parser to completely miss the identifier name of each
function.

This prevents improving the script to do some needed validation
tests.

Address this part. Yet, furter changes are needed in order
for it to fully follow the specs.

Acked-by: Kees Cook <keescook@chromium.org>
Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Link: https://lore.kernel.org/r/8383758160fdb4fcbb2ac56beeb874ca6dffc6b9.1610610937.git.mchehab+huawei@kernel.org
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
tools/testing/selftests/kselftest_harness.h