https://bugs.linaro.org/show_bug.cgi?id=3238

            Bug ID: 3238
           Summary: doxygen warnings on helper header files
           Product: OpenDataPlane - linux- generic reference
           Version: api-next
          Hardware: Other
                OS: Linux
            Status: UNCONFIRMED
          Severity: normal
          Priority: ---
         Component: Helpers
          Assignee: lng-odp@lists.linaro.org
          Reporter: petri.savolai...@linaro.org
                CC: lng-odp@lists.linaro.org
  Target Milestone: ---

On api-next (at least) "make doxygen-doc" prints out a bunch of Doxygen
warnings from helper header files:


  DXGEN  doc/application-api-guide/Doxyfile
  DXGEN  doc/helper-guide/Doxyfile
/odp/helper/include/odph_list_internal.h:21: warning: Compound odph_list_object
is not documented.
/odp/helper/include/odp/helper/ip.h:98: warning: Member
odph_ipv4_csum(odp_packet_t pkt, uint32_t offset, odph_ipv4hdr_t *ip,
odp_u16sum_t *chksum) (function) of group odph_header is not documented.
/odp/helper/include/odph_list_internal.h:72: warning: Member container_of(ptr,
type, list_node) (macro definition) of file odph_list_internal.h is not
documented.
/odp/helper/include/odph_list_internal.h:75: warning: Member
ODPH_LIST_FOR_EACH(pos, list_head, type, list_node) (macro definition) of file
odph_list_internal.h is not documented.
/odp/helper/include/odph_list_internal.h:23: warning: Member odph_list_object
(typedef) of file odph_list_internal.h is not documented.
/odp/helper/include/odph_list_internal.h:25: warning: Member odph_list_head
(typedef) of file odph_list_internal.h is not documented.
/odp/helper/include/odph_list_internal.h:27: warning: Member
ODPH_INIT_LIST_HEAD(odph_list_object *list) (function) of file
odph_list_internal.h is not documented.
/odp/helper/include/odph_list_internal.h:33: warning: Member
__odph_list_add(odph_list_object *new, odph_list_object *prev, odph_list_object
*next) (function) of file odph_list_internal.h is not documented.
/odp/helper/include/odph_list_internal.h:43: warning: Member
odph_list_add(odph_list_object *new, odph_list_object *head) (function) of file
odph_list_internal.h is not documented.
/odp/helper/include/odph_list_internal.h:48: warning: Member
odph_list_add_tail(struct odph_list_object *new, odph_list_object *head)
(function) of file odph_list_internal.h is not documented.
/odp/helper/include/odph_list_internal.h:54: warning: Member
__odph_list_del(struct odph_list_object *prev, odph_list_object *next)
(function) of file odph_list_internal.h is not documented.
/odp/helper/include/odph_list_internal.h:61: warning: Member
odph_list_del(struct odph_list_object *entry) (function) of file
odph_list_internal.h is not documented.
/odp/helper/include/odph_list_internal.h:67: warning: Member
odph_list_empty(const struct odph_list_object *head) (function) of file
odph_list_internal.h is not documented.
/odp/helper/include/odph_list_internal.h:75: warning: parameters of member
ODPH_LIST_FOR_EACH are not (all) documented
/odp/helper/include/odp/helper/ip.h:98: warning: Member
odph_ipv4_csum(odp_packet_t pkt, uint32_t offset, odph_ipv4hdr_t *ip,
odp_u16sum_t *chksum) (function) of group odph_header is not documented.
/odp/helper/include/odph_list_internal.h:22: warning: Member next (variable) of
class odph_list_object is not documented.
/odp/helper/include/odph_list_internal.h:22: warning: Member prev (variable) of
class odph_list_object is not documented.
  DXGEN  doc/platform-api-guide/Doxyfile
  DXGEN  doc/driver-api-guide/Doxyfile

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

Reply via email to