Re: [PATCH] libdvbv5: Fix invalid header file name in Doxygen INPUT

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

 



By the way, on this topic, there's a set of Doxygen warnings:

lib/include/libdvbv5/pmt.h:59: warning: documented symbol 'stream_reserved0' was not declared or defined.
lib/include/libdvbv5/pmt.h:101: warning: documented symbol 'stream_reserved' was not declared or defined.
lib/include/libdvbv5/pmt.h:103: warning: documented symbol 'stream_private' was not declared or defined.
lib/include/libdvbv5/dvb-dev.h:117: warning: Found unknown command '@type'
lib/include/libdvbv5/dvb-dev.h:173: warning: argument 'enable_monitor' of command @param is not found in the argument list of dvb_dev_find(struct dvb_device *dvb, dvb_dev_change_t handler, void *user_priv)
lib/include/libdvbv5/dvb-dev.h:173: warning: The following parameter of dvb_dev_find(struct dvb_device *dvb, dvb_dev_change_t handler, void *user_priv) is not documented:
  parameter 'handler'
lib/include/libdvbv5/dvb-sat.h:149: warning: argument 'parms' of command @param is not found in the argument list of dvb_sat_real_freq(struct dvb_v5_fe_parms *p, int freq)
lib/include/libdvbv5/dvb-sat.h:149: warning: The following parameters of dvb_sat_real_freq(struct dvb_v5_fe_parms *p, int freq) are not documented:
  parameter 'p'
  parameter 'freq'
lib/include/libdvbv5/desc_extension.h:143: warning: argument 'buf' of command @param is not found in the argument list of dvb_desc_ext_print_func(struct dvb_v5_fe_parms *parms, const struct dvb_extension_descriptor *ext, const void *desc)

Mauro, if you had a chance to look at them, it would be nice to avoid
warnings at build time.

On Mon, Aug 29, 2022 at 04:15:11AM +0300, Laurent Pinchart wrote:
> The list of INPUT files in doxygen_libdvbv5.cfg contains
> desc_descriptor_id.h, which doesn't exist. The correct file name is
> desc_registration_id.h. Fix it.
> 
> Signed-off-by: Laurent Pinchart <laurent.pinchart@xxxxxxxxxxxxxxxx>
> ---
>  doxygen_libdvbv5.cfg | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/doxygen_libdvbv5.cfg b/doxygen_libdvbv5.cfg
> index b25301a05bf5..83f33a23ebf4 100644
> --- a/doxygen_libdvbv5.cfg
> +++ b/doxygen_libdvbv5.cfg
> @@ -776,7 +776,6 @@ INPUT                  = $(SRCDIR)/doc/libdvbv5-index.doc \
>  			 $(SRCDIR)/lib/include/libdvbv5/desc_event_extended.h \
>  			 $(SRCDIR)/lib/include/libdvbv5/desc_event_short.h \
>  			 $(SRCDIR)/lib/include/libdvbv5/desc_extension.h \
> -			 $(SRCDIR)/lib/include/libdvbv5/desc_descriptor_id.h \
>  			 $(SRCDIR)/lib/include/libdvbv5/desc_frequency_list.h \
>  			 $(SRCDIR)/lib/include/libdvbv5/desc_hierarchy.h \
>  			 $(SRCDIR)/lib/include/libdvbv5/desc_isdbt_delivery.h \
> @@ -784,6 +783,7 @@ INPUT                  = $(SRCDIR)/doc/libdvbv5-index.doc \
>  			 $(SRCDIR)/lib/include/libdvbv5/desc_logical_channel.h \
>  			 $(SRCDIR)/lib/include/libdvbv5/desc_network_name.h \
>  			 $(SRCDIR)/lib/include/libdvbv5/desc_partial_reception.h \
> +			 $(SRCDIR)/lib/include/libdvbv5/desc_registration_id.h \
>  			 $(SRCDIR)/lib/include/libdvbv5/desc_sat.h \
>  			 $(SRCDIR)/lib/include/libdvbv5/desc_service.h \
>  			 $(SRCDIR)/lib/include/libdvbv5/desc_t2_delivery.h \
> 
> base-commit: f50720c40409bfd27056011da1350462b41af9d3

-- 
Regards,

Laurent Pinchart



[Index of Archives]     [Linux Input]     [Video for Linux]     [Gstreamer Embedded]     [Mplayer Users]     [Linux USB Devel]     [Linux Audio Users]     [Linux Kernel]     [Linux SCSI]     [Yosemite Backpacking]

  Powered by Linux