[PATCH] drm/amdgpu: update documentation for amdgpu_drv.c

[Jiang, Sonny]

Hi Alex,


What's your opinion about Michel's suggestion?


Thanks,

Sonny

________________________________
From: Michel Dänzer <michel at daenzer.net>
Sent: Thursday, June 28, 2018 4:39:57 AM
To: Jiang, Sonny
Cc: amd-gfx at lists.freedesktop.org
Subject: Re: [PATCH] drm/amdgpu: update documentation for amdgpu_drv.c


Hi Sonny,


would it be possible to put the documentation of each parameter directly
next to its definition / declaration? Otherwise, I'm afraid the
documentation will quickly fall out of date WRT the code.


> +/**
> + * DOC: module_parameters

Otherwise, this needs to be referenced in Documentation/gpu/amdgpu.rst,
or the contents of this comment don't show up in the generated
documentation.


--
Earthling Michel Dänzer               |               http://www.amd.com
Libre software enthusiast             |             Mesa and X developer
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <https://lists.freedesktop.org/archives/amd-gfx/attachments/20180628/70d64dc0/attachment-0001.html>