DPDK patches and discussions
 help / color / mirror / Atom feed
From: bugzilla@dpdk.org
To: dev@dpdk.org
Subject: [dpdk-dev] [Bug 730] [19.11] doxygen build warnings with version 1.9.1
Date: Thu, 10 Jun 2021 11:11:36 +0000	[thread overview]
Message-ID: <bug-730-3@http.bugs.dpdk.org/> (raw)

https://bugs.dpdk.org/show_bug.cgi?id=730

            Bug ID: 730
           Summary: [19.11] doxygen build warnings with version 1.9.1
           Product: DPDK
           Version: 19.11
          Hardware: All
                OS: All
            Status: UNCONFIRMED
          Severity: normal
          Priority: Normal
         Component: doc
          Assignee: dev@dpdk.org
          Reporter: alialnu@nvidia.com
  Target Milestone: ---

"""
$ meson --werror -Denable_docs=true build && ninja-build -C build doc
...
...
[2/4] Generating doxygen with a custom command
Doxygen version used: 1.9.1
Searching for include files...
Searching for example files...
Searching for files in directory examples
...
...
Generating code for file lib/librte_vhost/rte_vhost_crypto.h...
Generatinglib/librte_compressdev/rte_compressdev_pmd.h:142: warning: The
following parameter of compressdev_info_get_t(struct rte_compressdev *dev,
struct rte_compressdev_info *dev_info) is not documented:
  parameter 'dev_info'
lib/librte_cryptodev/rte_cryptodev_pmd.h:128: warning: The following parameter
of cryptodev_configure_t(struct rte_cryptodev *dev, struct rte_cryptodev_config
*config) is not documented:
  parameter 'config'
lib/librte_cryptodev/rte_cryptodev_pmd.h:181: warning: The following parameter
of cryptodev_info_get_t(struct rte_cryptodev *dev, struct rte_cryptodev_info
*dev_info) is not documented:
  parameter 'dev_info'
lib/librte_cryptodev/rte_cryptodev_pmd.h:221: warning: argument 'obj_cache' of
command @param is not found in the argument list of
cryptodev_sym_create_session_pool_t(struct rte_cryptodev *dev, unsigned
nb_objs, unsigned obj_cache_size, int socket_id)
lib/librte_cryptodev/rte_cryptodev_pmd.h:232: warning: The following parameter
of cryptodev_sym_create_session_pool_t(struct rte_cryptodev *dev, unsigned
nb_objs, unsigned obj_cache_size, int socket_id) is not documented:
  parameter 'obj_cache_size'
lib/librte_cryptodev/rte_cryptodev_pmd.h:261: warning: argument 'priv_sess' of
command @param is not found in the argument list of
cryptodev_sym_configure_session_t(struct rte_cryptodev *dev, struct
rte_crypto_sym_xform *xform, struct rte_cryptodev_sym_session *session, struct
rte_mempool *mp)
lib/librte_cryptodev/rte_cryptodev_pmd.h:274: warning: The following parameter
of cryptodev_sym_configure_session_t(struct rte_cryptodev *dev, struct
rte_crypto_sym_xform *xform, struct rte_cryptodev_sym_session *session, struct
rte_mempool *mp) is not documented:
  parameter 'session'
lib/librte_cryptodev/rte_cryptodev_pmd.h:279: warning: argument 'priv_sess' of
command @param is not found in the argument list of
cryptodev_asym_configure_session_t(struct rte_cryptodev *dev, struct
rte_crypto_asym_xform *xform, struct rte_cryptodev_asym_session *session,
struct rte_mempool *mp)
lib/librte_cryptodev/rte_cryptodev_pmd.h:292: warning: The following parameter
of cryptodev_asym_configure_session_t(struct rte_cryptodev *dev, struct
rte_crypto_asym_xform *xform, struct rte_cryptodev_asym_session *session,
struct rte_mempool *mp) is not documented:
  parameter 'session'
 file documentation...
Generating docs for file drivers/bus/vdev/rte_bus_vdev.h...
...
...
Generating docs for file lib/librte_eal/common/include/rte_hexdump.h...
Generating docs for file
lib/librte_eallib/librte_eal/common/include/rte_keepalive.h:47: warning:
argument 'Timestamp' of command @param is not found in the argument list of
rte_keepalive_relay_callback_t(void *data, const int id_core, enum
rte_keepalive_state core_state, uint64_t last_seen)
lib/librte_eal/common/include/rte_keepalive.h:57: warning: The following
parameter of rte_keepalive_relay_callback_t(void *data, const int id_core, enum
rte_keepalive_state core_state, uint64_t last_seen) is not documented:
  parameter 'last_seen'
lib/librte_eventdev/rte_eventdev_pmd.h:288: warning: argument 'link' of command
@param is not found in the argument list of eventdev_port_link_t(struct
rte_eventdev *dev, void *port, const uint8_t queues[], const uint8_t
priorities[], uint16_t nb_links)
lib/librte_eventdev/rte_eventdev_pmd.h:307: warning: The following parameter of
eventdev_port_link_t(struct rte_eventdev *dev, void *port, const uint8_t
queues[], const uint8_t priorities[], uint16_t nb_links) is not documented:
  parameter 'queues'
lib/librte_eventdev/rte_eventdev_pmd.h:389: warning: The following parameters
of eventdev_xstats_get_t(const struct rte_eventdev *dev, enum
rte_event_dev_xstats_mode mode, uint8_t queue_port_id, const unsigned int
ids[], uint64_t values[], unsigned int n) are not documented:
  parameter 'mode'
  parameter 'queue_port_id'
lib/librte_eventdev/rte_eventdev_pmd.h:417: warning: The following parameters
of eventdev_xstats_get_names_t(const struct rte_eventdev *dev, enum
rte_event_dev_xstats_mode mode, uint8_t queue_port_id, struct
rte_event_dev_xstats_name *xstats_names, unsigned int *ids, unsigned int size)
are not documented:
  parameter 'mode'
  parameter 'queue_port_id'
  parameter 'ids'
/common/include/rte_hypervisor.h...
Generating docs for file lib/librte_eal/common/include/rte_interrupts.h...
...
...
Generating docs for file lib/librte_mbuf/rte_mbuf_pool_ops.h...
Generatinlib/librte_port/rte_port.h:173: warning: argument 'pkts' of command
@param is not found in the argument list of rte_port_out_op_tx_bulk(void *port,
struct rte_mbuf **pkt, uint64_t pkts_mask)
lib/librte_port/rte_port.h:187: warning: The following parameter of
rte_port_out_op_tx_bulk(void *port, struct rte_mbuf **pkt, uint64_t pkts_mask)
is not documented:
  parameter 'pkt'
lib/librte_rawdev/rte_rawdev_pmd.h:249: warning: argument 'Raw' of command
@param is not found in the argument list of rawdev_queue_count_t(struct
rte_rawdev *dev)
lib/librte_rawdev/rte_rawdev_pmd.h:264: warning: The following parameter of
rawdev_queue_count_t(struct rte_rawdev *dev) is not documented:
  parameter 'dev'
lib/librte_rawdev/rte_rawdev_pmd.h:267: warning: argument 'bufs' of command
@param is not found in the argument list of rawdev_enqueue_bufs_t(struct
rte_rawdev *dev, struct rte_rawdev_buf **buffers, unsigned int count,
rte_rawdev_obj_t context)
lib/librte_rawdev/rte_rawdev_pmd.h:288: warning: The following parameter of
rawdev_enqueue_bufs_t(struct rte_rawdev *dev, struct rte_rawdev_buf **buffers,
unsigned int count, rte_rawdev_obj_t context) is not documented:
  parameter 'buffers'
lib/librte_rawdev/rte_rawdev_pmd.h:294: warning: argument 'bufs' of command
@param is not found in the argument list of rawdev_dequeue_bufs_t(struct
rte_rawdev *dev, struct rte_rawdev_buf **buffers, unsigned int count,
rte_rawdev_obj_t context)
lib/librte_rawdev/rte_rawdev_pmd.h:313: warning: The following parameter of
rawdev_dequeue_bufs_t(struct rte_rawdev *dev, struct rte_rawdev_buf **buffers,
unsigned int count, rte_rawdev_obj_t context) is not documented:
  parameter 'buffers'
lib/librte_rawdev/rte_rawdev_pmd.h:434: warning: argument 'status' of command
@param is not found in the argument list of rawdev_firmware_status_get_t(struct
rte_rawdev *dev, rte_rawdev_obj_t status_info)
lib/librte_rawdev/rte_rawdev_pmd.h:445: warning: The following parameter of
rawdev_firmware_status_get_t(struct rte_rawdev *dev, rte_rawdev_obj_t
status_info) is not documented:
  parameter 'status_info'
lib/librte_rawdev/rte_rawdev_pmd.h:463: warning: argument 'firmware_file' of
command @param is not found in the argument list of
rawdev_firmware_load_t(struct rte_rawdev *dev, rte_rawdev_obj_t firmware_buf)
lib/librte_rawdev/rte_rawdev_pmd.h:476: warning: The following parameter of
rawdev_firmware_load_t(struct rte_rawdev *dev, rte_rawdev_obj_t firmware_buf)
is not documented:
  parameter 'firmware_buf'
lib/librte_security/rte_security_driver.h:42: warning: argument 'dev' of
command @param is not found in the argument list of
security_session_destroy_t(void *device, struct rte_security_session *sess)
lib/librte_security/rte_security_driver.h:47: warning: The following parameter
of security_session_destroy_t(void *device, struct rte_security_session *sess)
is not documented:
  parameter 'device'
lib/librte_security/rte_security_driver.h:93: warning: argument 'mb' of command
@param is not found in the argument list of security_set_pkt_metadata_t(void
*device, struct rte_security_session *sess, struct rte_mbuf *m, void *params)
lib/librte_security/rte_security_driver.h:93: warning: argument 'mt' of command
@param is not found in the argument list of security_set_pkt_metadata_t(void
*device, struct rte_security_session *sess, struct rte_mbuf *m, void *params)
lib/librte_security/rte_security_driver.h:103: warning: The following
parameters of security_set_pkt_metadata_t(void *device, struct
rte_security_session *sess, struct rte_mbuf *m, void *params) are not
documented:
  parameter 'device'
  parameter 'm'
  parameter 'params'
lib/librte_table/rte_table.h:128: warning: argument 'key' of command @param is
not found in the argument list of rte_table_op_entry_add_bulk(void *table, void
**keys, void **entries, uint32_t n_keys, int *key_found, void **entries_ptr)
lib/librte_table/rte_table.h:156: warning: The following parameter of
rte_table_op_entry_add_bulk(void *table, void **keys, void **entries, uint32_t
n_keys, int *key_found, void **entries_ptr) is not documented:
  parameter 'keys'
lib/librte_table/rte_table.h:165: warning: argument 'key' of command @param is
not found in the argument list of rte_table_op_entry_delete_bulk(void *table,
void **keys, uint32_t n_keys, int *key_found, void **entries)
lib/librte_table/rte_table.h:191: warning: The following parameter of
rte_table_op_entry_delete_bulk(void *table, void **keys, uint32_t n_keys, int
*key_found, void **entries) is not documented:
  parameter 'keys'
g docs for file lib/librte_mbuf/rte_mbuf_ptype.h...

"""

OS: Fedora 35 (rawhide)
meson: 0.58.0
ninja-build: 1.10.2
doxygen: 1.9.1

-- 
You are receiving this mail because:
You are the assignee for the bug.

                 reply	other threads:[~2021-06-10 11:11 UTC|newest]

Thread overview: [no followups] expand[flat|nested]  mbox.gz  Atom feed

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=bug-730-3@http.bugs.dpdk.org/ \
    --to=bugzilla@dpdk.org \
    --cc=dev@dpdk.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).