From e2c6bd6932911a5e68fb400a2176ef69dcda8cc5 Mon Sep 17 00:00:00 2001 From: "jc_.kim" Date: Wed, 27 Sep 2017 13:10:01 +0900 Subject: [PATCH] doxygen: modify @file option to show path for including In doxygen output, file shows only a header file name. But with that, developer can't include a header to use specific APIs. Adding a path in @file option helps to include it. For example, "@file aa/bb.h" then, we can include it like belows. "#include " --- external/include/mbedtls/see_api.h | 2 +- external/include/mbedtls/see_internal.h | 2 +- external/include/protocols/dhcpc.h | 2 +- external/include/protocols/dhcpd.h | 2 +- external/include/protocols/libcoap/address.h | 2 +- external/include/protocols/libcoap/async.h | 2 +- external/include/protocols/libcoap/bits.h | 2 +- external/include/protocols/libcoap/coap_time.h | 2 +- external/include/protocols/libcoap/hashkey.h | 2 +- external/include/protocols/libcoap/prng.h | 2 +- external/include/protocols/libcoap/resource.h | 2 +- external/include/protocols/libcoap/t_list.h | 2 +- external/include/protocols/mdnsd.h | 2 +- external/include/protocols/ntpclient.h | 2 +- external/include/protocols/webclient.h | 2 +- external/include/protocols/webserver/http_keyvalue_list.h | 2 +- external/include/protocols/webserver/http_server.h | 2 +- external/include/protocols/websocket.h | 10 ++++------ framework/include/dm/dm_connectivity.h | 2 +- framework/include/dm/dm_error.h | 2 +- framework/include/dm/dm_lwm2m.h | 2 +- framework/include/iotbus/iotbus_error.h | 2 +- framework/include/iotbus/iotbus_gpio.h | 2 +- framework/include/iotbus/iotbus_i2c.h | 2 +- framework/include/iotbus/iotbus_pwm.h | 2 +- framework/include/iotbus/iotbus_spi.h | 2 +- framework/include/iotbus/iotbus_uart.h | 2 +- framework/include/network/mqtt/mqtt_api.h | 2 +- framework/include/st_things/st_things.h | 2 +- framework/include/st_things/st_things_types.h | 2 +- framework/include/wifi_manager/wifi_manager.h | 2 +- os/include/arpa/inet.h | 2 +- os/include/net/lwip/dhcp.h | 2 +- os/include/net/lwip/netif.h | 2 +- os/include/sys/ioctl.h | 2 +- os/include/sys/mount.h | 2 +- os/include/sys/select.h | 2 +- os/include/sys/socket.h | 2 +- os/include/sys/stat.h | 2 +- os/include/tinyara/net/dns.h | 2 +- os/include/tinyara/ringbuf.h | 2 +- os/include/tinyara/ttrace.h | 2 +- 42 files changed, 45 insertions(+), 47 deletions(-) diff --git a/external/include/mbedtls/see_api.h b/external/include/mbedtls/see_api.h index 35e6108..c31cd4a 100644 --- a/external/include/mbedtls/see_api.h +++ b/external/include/mbedtls/see_api.h @@ -15,7 +15,7 @@ * language governing permissions and limitations under the License. * ****************************************************************************/ -/// @file see/see_api.h +/// @file mbedtls/see_api.h /// @brief SEE api is supporting security api for using secure storage. #ifndef __SEE_API_H diff --git a/external/include/mbedtls/see_internal.h b/external/include/mbedtls/see_internal.h index 09f5dc1..67ded2d 100644 --- a/external/include/mbedtls/see_internal.h +++ b/external/include/mbedtls/see_internal.h @@ -16,7 +16,7 @@ * ****************************************************************************/ -/// @file see/see_internal.h +/// @file mbedtls/see_internal.h /// @brief SEE api for using in TLS internal. #ifndef __SEE_INTERNAL_H diff --git a/external/include/protocols/dhcpc.h b/external/include/protocols/dhcpc.h index 8e0ceb2..105a6b7 100644 --- a/external/include/protocols/dhcpc.h +++ b/external/include/protocols/dhcpc.h @@ -59,7 +59,7 @@ * @{ */ /** - * @file dhcpc.h + * @file protocols/dhcpc.h * @brief APIs for DHCP client */ diff --git a/external/include/protocols/dhcpd.h b/external/include/protocols/dhcpd.h index 2a1f5bf..a8aa0f8 100644 --- a/external/include/protocols/dhcpd.h +++ b/external/include/protocols/dhcpd.h @@ -58,7 +58,7 @@ */ /** - * @file netif.h + * @file protocols/dhcpd.h * @brief netif API (to be used from lwIP TCPIP thread) */ diff --git a/external/include/protocols/libcoap/address.h b/external/include/protocols/libcoap/address.h index 2326402..9902981 100644 --- a/external/include/protocols/libcoap/address.h +++ b/external/include/protocols/libcoap/address.h @@ -24,7 +24,7 @@ */ /** - * @file address.h + * @file protocols/libcoap/address.h * @brief representation of network addresses */ diff --git a/external/include/protocols/libcoap/async.h b/external/include/protocols/libcoap/async.h index 1885228..c56de38 100644 --- a/external/include/protocols/libcoap/async.h +++ b/external/include/protocols/libcoap/async.h @@ -24,7 +24,7 @@ */ /** - * @file async.h + * @file protocols/libcoap/async.h * @brief state management for asynchronous messages */ diff --git a/external/include/protocols/libcoap/bits.h b/external/include/protocols/libcoap/bits.h index f6fbceb..8307821 100644 --- a/external/include/protocols/libcoap/bits.h +++ b/external/include/protocols/libcoap/bits.h @@ -25,7 +25,7 @@ */ /** - * @file bits.h + * @file protocols/libcoap/bits.h * @brief bit vector manipulation */ diff --git a/external/include/protocols/libcoap/coap_time.h b/external/include/protocols/libcoap/coap_time.h index e33777f..4a77db9 100644 --- a/external/include/protocols/libcoap/coap_time.h +++ b/external/include/protocols/libcoap/coap_time.h @@ -24,7 +24,7 @@ */ /** - * @file coap_time.h + * @file protocols/libcoap/coap_time.h * @brief Clock Handling */ diff --git a/external/include/protocols/libcoap/hashkey.h b/external/include/protocols/libcoap/hashkey.h index 2f6f14b..323578e 100644 --- a/external/include/protocols/libcoap/hashkey.h +++ b/external/include/protocols/libcoap/hashkey.h @@ -24,7 +24,7 @@ */ /** - * @file hashkey.h + * @file protocols/libcoap/hashkey.h * @brief definition of hash key type and helper functions */ diff --git a/external/include/protocols/libcoap/prng.h b/external/include/protocols/libcoap/prng.h index 8f20dab..25db86a 100644 --- a/external/include/protocols/libcoap/prng.h +++ b/external/include/protocols/libcoap/prng.h @@ -24,7 +24,7 @@ */ /** - * @file prng.h + * @file protocols/libcoap/prng.h * @brief Pseudo Random Numbers */ diff --git a/external/include/protocols/libcoap/resource.h b/external/include/protocols/libcoap/resource.h index 8c0bc9c..2d54303 100644 --- a/external/include/protocols/libcoap/resource.h +++ b/external/include/protocols/libcoap/resource.h @@ -24,7 +24,7 @@ */ /** - * @file resource.h + * @file protocols/libcoap/resource.h * @brief generic resource handling */ diff --git a/external/include/protocols/libcoap/t_list.h b/external/include/protocols/libcoap/t_list.h index 288d712..37db808 100644 --- a/external/include/protocols/libcoap/t_list.h +++ b/external/include/protocols/libcoap/t_list.h @@ -41,7 +41,7 @@ */ /** - * @file t_list.h + * @file protocols/libcoap/t_list.h * @brief Wrappers for list structures and functions */ diff --git a/external/include/protocols/mdnsd.h b/external/include/protocols/mdnsd.h index f5eb827..e69af1d 100644 --- a/external/include/protocols/mdnsd.h +++ b/external/include/protocols/mdnsd.h @@ -49,7 +49,7 @@ * @{ */ /** - * @file mdnsd.h + * @file protocols/mdnsd.h * @brief APIs for Multicast DNS */ diff --git a/external/include/protocols/ntpclient.h b/external/include/protocols/ntpclient.h index c36520e..a56ebd2 100644 --- a/external/include/protocols/ntpclient.h +++ b/external/include/protocols/ntpclient.h @@ -56,7 +56,7 @@ * @{ */ -/// @file ntpclient.h +/// @file protocols/ntpclient.h /// @brief APIs for NTP Client #ifndef __APPS_INCLUDE_NETUTILS_NTPCLIENT_H diff --git a/external/include/protocols/webclient.h b/external/include/protocols/webclient.h index e677ffe..d1bb899 100644 --- a/external/include/protocols/webclient.h +++ b/external/include/protocols/webclient.h @@ -26,7 +26,7 @@ */ /** - * @file webclient.h + * @file protocols/webclient.h * @brief APIs for HTTP Client. */ diff --git a/external/include/protocols/webserver/http_keyvalue_list.h b/external/include/protocols/webserver/http_keyvalue_list.h index 58bf747..25fa147 100644 --- a/external/include/protocols/webserver/http_keyvalue_list.h +++ b/external/include/protocols/webserver/http_keyvalue_list.h @@ -21,7 +21,7 @@ */ /** - * @file http_keyvalue_list.h + * @file protocols/webserver/http_keyvalue_list.h * @brief APIs for key/value in HTTP Server. */ diff --git a/external/include/protocols/webserver/http_server.h b/external/include/protocols/webserver/http_server.h index a24c2f1..f10a610 100644 --- a/external/include/protocols/webserver/http_server.h +++ b/external/include/protocols/webserver/http_server.h @@ -29,7 +29,7 @@ */ /** - * @file http_server.h + * @file protocols/webserver/http_server.h * @brief APIs for HTTP Server. */ diff --git a/external/include/protocols/websocket.h b/external/include/protocols/websocket.h index c217f0b..f3be6a6 100644 --- a/external/include/protocols/websocket.h +++ b/external/include/protocols/websocket.h @@ -16,10 +16,6 @@ * ****************************************************************************/ /** - * @file websocket.h - * @brief websocket header to support WS/WSS server and client. - */ -/** * @defgroup Websocket Websocket * @brief Provides APIs for Websocket * @ingroup NETWORK @@ -27,8 +23,10 @@ * @{ */ -/// @file app/include/netutils/websocket.h -/// @brief websocket api header. +/** + * @file protocols/websocket.h + * @brief websocket header to support WS/WSS server and client. + */ #ifndef __APPS_INCLUDE_NETUTILS_WEBSOCKET_H #define __APPS_INCLUDE_NETUTILS_WEBSOCKET_H diff --git a/framework/include/dm/dm_connectivity.h b/framework/include/dm/dm_connectivity.h index afc365a..d7bee5d 100644 --- a/framework/include/dm/dm_connectivity.h +++ b/framework/include/dm/dm_connectivity.h @@ -24,7 +24,7 @@ */ /** - * @file dm_connectivity.h + * @file dm/dm_connectivity.h * @brief DM Connectivity APIs */ diff --git a/framework/include/dm/dm_error.h b/framework/include/dm/dm_error.h index 9160bf0..d01a0a8 100644 --- a/framework/include/dm/dm_error.h +++ b/framework/include/dm/dm_error.h @@ -23,7 +23,7 @@ */ /** - * @file dm_error.h + * @file dm/dm_error.h * @brief Definition of dm_error */ diff --git a/framework/include/dm/dm_lwm2m.h b/framework/include/dm/dm_lwm2m.h index 5e8921e..00dc9eb 100644 --- a/framework/include/dm/dm_lwm2m.h +++ b/framework/include/dm/dm_lwm2m.h @@ -24,7 +24,7 @@ */ /** - * @file dm_lwm2m.h + * @file dm/dm_lwm2m.h * @brief device management APIs for DM */ diff --git a/framework/include/iotbus/iotbus_error.h b/framework/include/iotbus/iotbus_error.h index 874c8dd..5f239ff 100644 --- a/framework/include/iotbus/iotbus_error.h +++ b/framework/include/iotbus/iotbus_error.h @@ -23,7 +23,7 @@ */ /** - * @file iotbus_error.h + * @file iotbus/iotbus_error.h * @brief Definition of iotbus_error */ diff --git a/framework/include/iotbus/iotbus_gpio.h b/framework/include/iotbus/iotbus_gpio.h index 7d9444c..9d7dcc2 100644 --- a/framework/include/iotbus/iotbus_gpio.h +++ b/framework/include/iotbus/iotbus_gpio.h @@ -24,7 +24,7 @@ */ /** - * @file iotbus_gpio.h + * @file iotbus/iotbus_gpio.h * @brief Iotbus APIs for GPIO */ diff --git a/framework/include/iotbus/iotbus_i2c.h b/framework/include/iotbus/iotbus_i2c.h index 3843200..74565e9 100644 --- a/framework/include/iotbus/iotbus_i2c.h +++ b/framework/include/iotbus/iotbus_i2c.h @@ -24,7 +24,7 @@ */ /** - * @file iotbus_i2c.h + * @file iotbus/iotbus_i2c.h * @brief Iotbus APIs for I2C */ diff --git a/framework/include/iotbus/iotbus_pwm.h b/framework/include/iotbus/iotbus_pwm.h index 724b314..2b5b660 100644 --- a/framework/include/iotbus/iotbus_pwm.h +++ b/framework/include/iotbus/iotbus_pwm.h @@ -24,7 +24,7 @@ */ /** - * @file iotbus_pwm.h + * @file iotbus/iotbus_pwm.h * @brief Iotbus APIs for PWM */ diff --git a/framework/include/iotbus/iotbus_spi.h b/framework/include/iotbus/iotbus_spi.h index 2e88c5d..8949223 100644 --- a/framework/include/iotbus/iotbus_spi.h +++ b/framework/include/iotbus/iotbus_spi.h @@ -24,7 +24,7 @@ */ /** - * @file iotbus_spi.h + * @file iotbus/iotbus_spi.h * @brief Iotbus APIs for SPI */ diff --git a/framework/include/iotbus/iotbus_uart.h b/framework/include/iotbus/iotbus_uart.h index 6427524..63ce381 100644 --- a/framework/include/iotbus/iotbus_uart.h +++ b/framework/include/iotbus/iotbus_uart.h @@ -24,7 +24,7 @@ */ /** - * @file iotbus_uart.h + * @file iotbus/iotbus_uart.h * @brief Iotbus APIs for UART */ diff --git a/framework/include/network/mqtt/mqtt_api.h b/framework/include/network/mqtt/mqtt_api.h index 01a149e..53b6825 100644 --- a/framework/include/network/mqtt/mqtt_api.h +++ b/framework/include/network/mqtt/mqtt_api.h @@ -21,7 +21,7 @@ * @{ */ /** - * @file mqtt_api.h + * @file network/mqtt/mqtt_api.h * @brief APIs for MQTT Client(Subscriber/Publisher) */ diff --git a/framework/include/st_things/st_things.h b/framework/include/st_things/st_things.h index dab3cf5..49284c3 100644 --- a/framework/include/st_things/st_things.h +++ b/framework/include/st_things/st_things.h @@ -23,7 +23,7 @@ */ /** - * @file st_things.h + * @file st_things/st_things.h * @brief Provides APIs for SmartThings Things SDK */ diff --git a/framework/include/st_things/st_things_types.h b/framework/include/st_things/st_things_types.h index f0b20a0..4c4dd17 100644 --- a/framework/include/st_things/st_things_types.h +++ b/framework/include/st_things/st_things_types.h @@ -21,7 +21,7 @@ */ /** - * @file st_things_types.h + * @file st_things/st_things_types.h * @brief Provides structure definition for SmartThings Things SDK */ diff --git a/framework/include/wifi_manager/wifi_manager.h b/framework/include/wifi_manager/wifi_manager.h index f18fc71..a3b906f 100644 --- a/framework/include/wifi_manager/wifi_manager.h +++ b/framework/include/wifi_manager/wifi_manager.h @@ -24,7 +24,7 @@ */ /** - * @file wifi_manager.h + * @file wifi_manager/wifi_manager.h * @brief Provides APIs for Wi-Fi Manager */ diff --git a/os/include/arpa/inet.h b/os/include/arpa/inet.h index 395efa3..361be69 100644 --- a/os/include/arpa/inet.h +++ b/os/include/arpa/inet.h @@ -57,7 +57,7 @@ */ /** - * @file inet.h + * @file arpa/inet.h * @brief inet API */ diff --git a/os/include/net/lwip/dhcp.h b/os/include/net/lwip/dhcp.h index 06e89c8..1e3485c 100644 --- a/os/include/net/lwip/dhcp.h +++ b/os/include/net/lwip/dhcp.h @@ -22,7 +22,7 @@ */ /** - * @file dhcp.h + * @file net/dhcp.h * @brief APIs for DHCP client */ #ifndef __LWIP_DHCP_H__ diff --git a/os/include/net/lwip/netif.h b/os/include/net/lwip/netif.h index b9fea18..cbfb597 100644 --- a/os/include/net/lwip/netif.h +++ b/os/include/net/lwip/netif.h @@ -54,7 +54,7 @@ */ /** - * @file netif.h + * @file net/lwip/netif.h * @brief netif API (to be used from lwIP TCPIP thread) */ diff --git a/os/include/sys/ioctl.h b/os/include/sys/ioctl.h index 8de34cd..b532036 100644 --- a/os/include/sys/ioctl.h +++ b/os/include/sys/ioctl.h @@ -57,7 +57,7 @@ * @{ */ -/// @file ioctl.h +/// @file sys/ioctl.h /// @brief I/O control APIs #ifndef __INCLUDE_SYS_IOCTL_H diff --git a/os/include/sys/mount.h b/os/include/sys/mount.h index dfba0f9..e02b9b6 100644 --- a/os/include/sys/mount.h +++ b/os/include/sys/mount.h @@ -57,7 +57,7 @@ * @{ */ -/// @file mount.h +/// @file sys/mount.h /// @brief mount APIs #ifndef __INCLUDE_SYS_MOUNT_H diff --git a/os/include/sys/select.h b/os/include/sys/select.h index 43f3404..fb6bbbd 100644 --- a/os/include/sys/select.h +++ b/os/include/sys/select.h @@ -57,7 +57,7 @@ * @{ */ -/// @file select.h +/// @file sys/select.h /// @brief synchronous I/O multiplexing APIs #ifndef __INCLUDE_SYS_SELECT_H diff --git a/os/include/sys/socket.h b/os/include/sys/socket.h index 269f351..3b0ef13 100644 --- a/os/include/sys/socket.h +++ b/os/include/sys/socket.h @@ -58,7 +58,7 @@ * @{ */ -/// @file socket.h +/// @file sys/socket.h /// @brief Socket APIs #ifndef __INCLUDE_SYS_SOCKET_H #define __INCLUDE_SYS_SOCKET_H diff --git a/os/include/sys/stat.h b/os/include/sys/stat.h index d2469e6..ed02186 100644 --- a/os/include/sys/stat.h +++ b/os/include/sys/stat.h @@ -58,7 +58,7 @@ * @{ */ -/// @file stat.h +/// @file sys/stat.h /// @brief Status APIs #ifndef __INCLUDE_SYS_STAT_H diff --git a/os/include/tinyara/net/dns.h b/os/include/tinyara/net/dns.h index 745e7ed..2f9102e 100644 --- a/os/include/tinyara/net/dns.h +++ b/os/include/tinyara/net/dns.h @@ -59,7 +59,7 @@ */ /** - * @file dns.h + * @file tinyara/net/dns.h * @brief DNS client API */ diff --git a/os/include/tinyara/ringbuf.h b/os/include/tinyara/ringbuf.h index 2abd79d..cf77ed7 100644 --- a/os/include/tinyara/ringbuf.h +++ b/os/include/tinyara/ringbuf.h @@ -22,7 +22,7 @@ * @{ */ -///@file ringbuf.h +///@file tinyara/ringbuf.h ///@brief ttrace ringbuffer APIs #ifndef __INCLUDE_TINYARA_TTRACE_RINGBUF_H diff --git a/os/include/tinyara/ttrace.h b/os/include/tinyara/ttrace.h index 4e76efd..c379d17 100644 --- a/os/include/tinyara/ttrace.h +++ b/os/include/tinyara/ttrace.h @@ -22,7 +22,7 @@ * @{ */ -///@file ttrace.h +///@file tinyara/ttrace.h ///@brief ttrace APIs #ifndef __INCLUDE_TINYARA_TTRACE_H -- 2.7.4