From cfb36a7950461ebdd8b24bd8e4515e7e05b4676c Mon Sep 17 00:00:00 2001 From: Philippe Brais Date: Mon, 1 Jan 2024 16:53:30 -0500 Subject: [PATCH 3/4] Fix links to function and files - Doxygen was not able to figure out "netif_add(struct netif *netif, ...)". - There are two files 'netdb.h', the other in 'compat/posix'. - Missing @file special command for 'pppapi.h'. --- doc/doxygen/main_page.h | 4 ++-- src/include/netif/ppp/pppapi.h | 6 ++++++ 2 files changed, 8 insertions(+), 2 deletions(-) diff --git a/doc/doxygen/main_page.h b/doc/doxygen/main_page.h index 86849cf5..c4c9a10f 100644 --- a/doc/doxygen/main_page.h +++ b/doc/doxygen/main_page.h @@ -271,7 +271,7 @@ Call these functions in the order of appearance: - lwip_init(): Initialize the lwIP stack and all of its subsystems. -- netif_add(struct netif *netif, ...): +- @ref netif_add "netif_add(struct netif *netif, ...)": Adds your network interface to the netif_list. Allocate a struct netif and pass a pointer to this structure as the first argument. Give pointers to cleared ip_addr structures when using DHCP, @@ -337,7 +337,7 @@ Call these functions in the order of appearance: * from these API header files are thread-safe: * - api.h * - netbuf.h - * - netdb.h + * - @ref lwip/netdb.h "netdb.h" * - netifapi.h * - pppapi.h * - sockets.h diff --git a/src/include/netif/ppp/pppapi.h b/src/include/netif/ppp/pppapi.h index 913d93f7..1de532a0 100644 --- a/src/include/netif/ppp/pppapi.h +++ b/src/include/netif/ppp/pppapi.h @@ -1,3 +1,9 @@ +/** + * @file + * @todo Document + * + */ + /* * Redistribution and use in source and binary forms, with or without modification, * are permitted provided that the following conditions are met: -- 2.43.0.windows.1