gpu: docs: amdgpu.rst: get rid of wrong kernel-doc markups
authorMauro Carvalho Chehab <mchehab+huawei@kernel.org>
Tue, 27 Oct 2020 09:51:30 +0000 (10:51 +0100)
committerJonathan Corbet <corbet@lwn.net>
Wed, 28 Oct 2020 17:42:02 +0000 (11:42 -0600)
commitcc507c435b05b23f62ae32c092de2da972a98d8e
tree70a7915e8c167a47a6eba035f1ef4ce6cf04122c
parentca766ff0c3b4a19ab2eef9a24161f77668c358c4
gpu: docs: amdgpu.rst: get rid of wrong kernel-doc markups

As reported by kernel-doc:
    ./drivers/gpu/drm/amd/amdgpu/amdgpu_xgmi.c:1: warning: no structured comments found
    ./drivers/gpu/drm/amd/amdgpu/amdgpu_ras.c:1: warning: no structured comments found

Those files only contain

/**
 * DOC:
 */

markups, but they're included twice there: one to parse
such markup, and another one to parse internal functions.

In the case of amdgpu_xgmi.c, as it has just one such
markup, we can simply include the file once, and let it
parse the entire file without passing arguments to kernel-doc.

This should place everything altogether.

For amdgpu_ras.c, however, we need to remove the kernel-doc
with just internal. This should be re-introduced if this
file ever gets new non-DOC markups.

Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Link: https://lore.kernel.org/r/bd070923591ae54f9587e7407b6291ac116952b2.1603791716.git.mchehab+huawei@kernel.org
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Documentation/gpu/amdgpu.rst