Re: [libgpiod][PATCH] core: doc: add doc for opaque structs to link to the relevant page

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



On Fri, Jun 9, 2023 at 9:40 AM Kent Gibson <warthog618@xxxxxxxxx> wrote:
>
> The C doxygen documentation is difficult to navigate as the opaque types
> do not get linked to anything.
>
> Add doc for each opaque struct that references the relevant page.
>
> Signed-off-by: Kent Gibson <warthog618@xxxxxxxxx>
> ---
>
> There might be a better way to do this, but this the best I've run
> across so far.  At least the generated doc is navigable without having to
> return to the modules page and perform mental gymnastics.
>
> Along the way, also renamed the request_request group to line_request as
> that makes more sense.
>
> Haven't pushed this one to rtd yet, as this is a more significant
> change - not just fixing a typo.
>
> Cheers,
> Kent.
>

Thanks for doing this. I tweaked the patch a little bit and applied to master.

Bart




[Index of Archives]     [Linux SPI]     [Linux Kernel]     [Linux ARM (vger)]     [Linux ARM MSM]     [Linux Omap]     [Linux Arm]     [Linux Tegra]     [Fedora ARM]     [Linux for Samsung SOC]     [eCos]     [Linux Fastboot]     [Gcc Help]     [Git]     [DCCP]     [IETF Announce]     [Security]     [Linux MIPS]     [Yosemite Campsites]

  Powered by Linux