| Message ID | 20230609040737.25666-1-warthog618@gmail.com |
|---|---|
| State | New |
| Headers | show |
| Series | [libgpiod] core: doc: fix line_config documentation generation | expand |
On Fri, Jun 9, 2023 at 6:07 AM Kent Gibson <warthog618@gmail.com> wrote: > > The line configuration is missing from the generated documentation as the > comment for the defgroup is a normal comment, not a doc comment. > > Add the asterisk to make the section a doc comment. > > Signed-off-by: Kent Gibson <warthog618@gmail.com> > --- > > I took the liberty of patching and updating the rtd documentation, so it > is already fixed there. > > It would be nice if the generated documentation would provide links from > the "struct gpiod_line_config" to the corresponding page. But not sure > how to do that, or if it is even possible. > > Cheers, > Kent. > > include/gpiod.h | 2 +- > 1 file changed, 1 insertion(+), 1 deletion(-) > > diff --git a/include/gpiod.h b/include/gpiod.h > index d1833de..5d4b6af 100644 > --- a/include/gpiod.h > +++ b/include/gpiod.h > @@ -715,7 +715,7 @@ int gpiod_line_settings_set_output_value(struct gpiod_line_settings *settings, > enum gpiod_line_value > gpiod_line_settings_get_output_value(struct gpiod_line_settings *settings); > > -/* > +/** > * @} > * > * @defgroup line_config Line configuration objects > -- > 2.40.1 > Applied, thanks! Bart
diff --git a/include/gpiod.h b/include/gpiod.h index d1833de..5d4b6af 100644 --- a/include/gpiod.h +++ b/include/gpiod.h @@ -715,7 +715,7 @@ int gpiod_line_settings_set_output_value(struct gpiod_line_settings *settings, enum gpiod_line_value gpiod_line_settings_get_output_value(struct gpiod_line_settings *settings); -/* +/** * @} * * @defgroup line_config Line configuration objects
The line configuration is missing from the generated documentation as the comment for the defgroup is a normal comment, not a doc comment. Add the asterisk to make the section a doc comment. Signed-off-by: Kent Gibson <warthog618@gmail.com> --- I took the liberty of patching and updating the rtd documentation, so it is already fixed there. It would be nice if the generated documentation would provide links from the "struct gpiod_line_config" to the corresponding page. But not sure how to do that, or if it is even possible. Cheers, Kent. include/gpiod.h | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)