diff --git a/.github/workflows/basic_checks.yml b/.github/workflows/basic_checks.yml index e7c69d9..81ec97b 100644 --- a/.github/workflows/basic_checks.yml +++ b/.github/workflows/basic_checks.yml @@ -147,7 +147,7 @@ mkdir -p ${{ github.workspace }}/BUILD - name: Doxygen Action - uses: mattnotmitt/doxygen-action@v1.9.1 + uses: mattnotmitt/doxygen-action@v1.9.5 with: doxyfile-path: ./doxyfile_options diff --git a/.github/workflows/docs.yaml b/.github/workflows/docs.yaml index d659919..98d4242 100644 --- a/.github/workflows/docs.yaml +++ b/.github/workflows/docs.yaml @@ -21,7 +21,7 @@ # Build the HTML documentation - name: Doxygen Action - uses: mattnotmitt/doxygen-action@v1.9.1 + uses: mattnotmitt/doxygen-action@v1.9.5 with: doxyfile-path: ./doxyfile_options diff --git a/README.md b/README.md index 1b74251..c5b2f9e 100644 --- a/README.md +++ b/README.md @@ -36,9 +36,8 @@ ## Documentation -For more information about Mbed OS, please see [our published documentation](https://os.mbed.com/docs/latest). It includes general overview information, step-by-step tutorials, porting information and background reference materials about our architecture and tools. +For more information about Mbed OS, please see [the published Mbed OS documentation](https://os.mbed.com/docs/latest). It includes general overview information, step-by-step tutorials, porting information and background reference materials about our architecture and tools. -For the Mbed OS CE class-level documentation, see [here](https://mbed-ce.github.io/mbed-os/group__mbed-os-public.html) +For the Mbed OS CE code-level documentation (Doxygen), see [here](https://mbed-ce.github.io/mbed-os/group__mbed-os-public.html) -To contribute to this documentation, please see the [mbed-os-5-docs repository](https://github.com/ARMmbed/mbed-os-5-docs). diff --git a/connectivity/FEATURE_BLE/include/ble/driver/CordioHCIDriver.h b/connectivity/FEATURE_BLE/include/ble/driver/CordioHCIDriver.h index 35a6951..6227212 100644 --- a/connectivity/FEATURE_BLE/include/ble/driver/CordioHCIDriver.h +++ b/connectivity/FEATURE_BLE/include/ble/driver/CordioHCIDriver.h @@ -156,7 +156,6 @@ * * @param success True if the TEST END command was a success. * @param packets Number of packets received during the test. - * @return BLE_ERROR_NONE on success. */ void handle_test_end(bool success, uint16_t packets); diff --git a/connectivity/cellular/include/cellular/framework/API/CellularInformation.h b/connectivity/cellular/include/cellular/framework/API/CellularInformation.h index c4433a1..44d9057 100644 --- a/connectivity/cellular/include/cellular/framework/API/CellularInformation.h +++ b/connectivity/cellular/include/cellular/framework/API/CellularInformation.h @@ -76,6 +76,13 @@ */ virtual nsapi_error_t get_revision(char *buf, size_t buf_size) = 0; + enum SerialNumberType { + SN = 0, // Serial Number + IMEI = 1, // International Mobile station Equipment Identity + IMEISV = 2, // IMEI and Software Version number + SVN = 3 // Software Version Number + }; + /** Request serial number identification of cellular device * * @param buf serial number as zero terminated string @@ -86,12 +93,6 @@ * NSAPI_ERROR_UNSUPPORTED if the modem does not support SerialNumberType * NSAPI_ERROR_DEVICE_ERROR on other failures */ - enum SerialNumberType { - SN = 0, // Serial Number - IMEI = 1, // International Mobile station Equipment Identity - IMEISV = 2, // IMEI and Software Version number - SVN = 3 // Software Version Number - }; virtual nsapi_size_or_error_t get_serial_number(char *buf, size_t buf_size, SerialNumberType type = SN) = 0; /** Get IMSI from the sim card diff --git a/connectivity/cellular/include/cellular/framework/API/CellularNetwork.h b/connectivity/cellular/include/cellular/framework/API/CellularNetwork.h index 44a0aca..2fcff26 100644 --- a/connectivity/cellular/include/cellular/framework/API/CellularNetwork.h +++ b/connectivity/cellular/include/cellular/framework/API/CellularNetwork.h @@ -294,6 +294,10 @@ */ virtual nsapi_error_t get_ciot_network_optimization_config(CIoT_Supported_Opt &supported_network_opt) = 0; + enum SignalQuality { + SignalQualityUnknown = 99 + }; + /** Get signal quality parameters. * * @param rssi signal strength level as defined in 3GPP TS 27.007, range -113..-51 dBm or SignalQualityUnknown @@ -301,9 +305,6 @@ * @return NSAPI_ERROR_OK on success * NSAPI_ERROR_DEVICE_ERROR on other failures */ - enum SignalQuality { - SignalQualityUnknown = 99 - }; virtual nsapi_error_t get_signal_quality(int &rssi, int *ber = NULL) = 0; /** Get the last 3GPP error code @@ -372,6 +373,14 @@ */ virtual nsapi_error_t get_registration_params(RegistrationType type, registration_params_t ®_params) = 0; + enum EDRXAccessTechnology { + EDRXGSM_EC_GSM_IoT_mode = 1, + EDRXGSM_A_Gb_mode, + EDRXUTRAN_Iu_mode, + EDRXEUTRAN_WB_S1_mode, + EDRXEUTRAN_NB_S1_mode + }; + /** Set discontinuous reception time on cellular device. * * @remark See 3GPP TS 27.007 eDRX for details. @@ -383,13 +392,6 @@ * @return NSAPI_ERROR_OK on success * NSAPI_ERROR_DEVICE_ERROR on failure */ - enum EDRXAccessTechnology { - EDRXGSM_EC_GSM_IoT_mode = 1, - EDRXGSM_A_Gb_mode, - EDRXUTRAN_Iu_mode, - EDRXEUTRAN_WB_S1_mode, - EDRXEUTRAN_NB_S1_mode - }; virtual nsapi_error_t set_receive_period(int mode, EDRXAccessTechnology act_type, uint8_t edrx_value) = 0; /** Sets the packet domain network reporting. Useful for getting events when detached from the diff --git a/connectivity/libraries/ppp/include/ppp/ppp_service.h b/connectivity/libraries/ppp/include/ppp/ppp_service.h index 52964d4..7b0e629 100644 --- a/connectivity/libraries/ppp/include/ppp/ppp_service.h +++ b/connectivity/libraries/ppp/include/ppp/ppp_service.h @@ -41,22 +41,6 @@ static ppp_service &get_instance(); /** - * Callback to be registered with PPP interface and to be called for received packets - * - * @param buf Received data - */ - //typedef void (*ppp_link_input_fn)(void *data, net_stack_mem_buf_t *buf); - typedef mbed::Callback ppp_link_input_cb_t; - - /** - * Callback to be registered with PPP interface and to be called for link status changes - * - * @param up Link status - */ - //typedef void (*ppp_link_state_change_fn)(void *data, bool up); - typedef mbed::Callback ppp_link_state_change_cb_t; - - /** * Return maximum transmission unit * * @return MTU in bytes diff --git a/connectivity/lorawan/include/lorawan/LoRaRadio.h b/connectivity/lorawan/include/lorawan/LoRaRadio.h index 608f34e..093eab9 100644 --- a/connectivity/lorawan/include/lorawan/LoRaRadio.h +++ b/connectivity/lorawan/include/lorawan/LoRaRadio.h @@ -401,12 +401,12 @@ /** * Rx Done callback prototype. * - * @param payload Received buffer pointer. - * @param size Received buffer size. - * @param rssi RSSI value computed while receiving the frame [dBm]. - * @param snr Raw SNR value given by the radio hardware. - * FSK : N/A (set to 0) - * LoRa: SNR value in dB + *
\c payload : Received buffer pointer. + *
\c size : Received buffer size. + *
\c rssi : RSSI value computed while receiving the frame [dBm]. + *
\c snr : Raw SNR value given by the radio hardware. + * FSK : N/A (set to 0). + * LoRa: SNR value in dB. */ mbed::Callback rx_done; @@ -423,14 +423,14 @@ /** * FHSS Change Channel callback prototype. * - * @param current_channel The index number of the current channel. + *
\c current_channel : The index number of the current channel. */ mbed::Callback fhss_change_channel; /** * CAD Done callback prototype. * - * @param channel_busy True, if Channel activity detected. + *
\c channel_busy : True, if Channel activity detected. */ mbed::Callback cad_done; } radio_events_t; diff --git a/connectivity/nanostack/include/nanostack-interface/NanostackPPPPhy.h b/connectivity/nanostack/include/nanostack-interface/NanostackPPPPhy.h index 7d32625..6667608 100644 --- a/connectivity/nanostack/include/nanostack-interface/NanostackPPPPhy.h +++ b/connectivity/nanostack/include/nanostack-interface/NanostackPPPPhy.h @@ -24,7 +24,8 @@ public: /** Link state callback function prototype * - * @param up link up + *
+ * \c up : link up */ typedef mbed::Callback link_state_change_cb_t; diff --git a/connectivity/netsocket/include/netsocket/DNS.h b/connectivity/netsocket/include/netsocket/DNS.h index d67f941..39f8e2a 100644 --- a/connectivity/netsocket/include/netsocket/DNS.h +++ b/connectivity/netsocket/include/netsocket/DNS.h @@ -72,9 +72,10 @@ * The callback should not perform expensive operations such as socket recv/send * calls or blocking operations. * - * @param result Negative error code on failure or - * value that represents the number of DNS records - * @param address On success, destination for the host SocketAddress. + *
+ * \c result : Negative error code on failure or value that represents the number of DNS records + *
+ * \c address : On success, destination for the host SocketAddress. */ typedef mbed::Callback hostbyname_cb_t; diff --git a/connectivity/netsocket/include/netsocket/EMAC.h b/connectivity/netsocket/include/netsocket/EMAC.h index 6a688b2..c018a05 100644 --- a/connectivity/netsocket/include/netsocket/EMAC.h +++ b/connectivity/netsocket/include/netsocket/EMAC.h @@ -43,17 +43,17 @@ /** * Callback to be register with EMAC interface and to be called for received packets * - * @param buf Received data + *
+ * \c buf : Received data */ - //typedef void (*emac_link_input_fn)(void *data, emac_mem_buf_t *buf); typedef mbed::Callback emac_link_input_cb_t; /** * Callback to be register with EMAC interface and to be called for link status changes * - * @param up Link status + *
+ * \c up : Link status */ - //typedef void (*emac_link_state_change_fn)(void *data, bool up); typedef mbed::Callback emac_link_state_change_cb_t; /** diff --git a/connectivity/netsocket/include/netsocket/L3IP.h b/connectivity/netsocket/include/netsocket/L3IP.h index f71c53a..435396a 100644 --- a/connectivity/netsocket/include/netsocket/L3IP.h +++ b/connectivity/netsocket/include/netsocket/L3IP.h @@ -41,17 +41,17 @@ /** * Callback to be registered with L3IP interface and to be called for received packets * - * @param buf Received data + *
+ * \c buf : Received data */ - //typedef void (*l3ip_link_input_fn)(void *data, net_stack_mem_buf_t *buf); typedef mbed::Callback l3ip_link_input_cb_t; /** * Callback to be registered with L3IP interface and to be called for link status changes * - * @param up Link status + *
+ * \c up : Link status */ - //typedef void (*l3ip_link_state_change_fn)(void *data, bool up); typedef mbed::Callback l3ip_link_state_change_cb_t; /** diff --git a/connectivity/netsocket/include/netsocket/NetworkInterface.h b/connectivity/netsocket/include/netsocket/NetworkInterface.h index 17b0294..0301727 100644 --- a/connectivity/netsocket/include/netsocket/NetworkInterface.h +++ b/connectivity/netsocket/include/netsocket/NetworkInterface.h @@ -277,9 +277,10 @@ * The callback should not perform expensive operations such as socket recv/send * calls or blocking operations. * - * @param result Negative error code on failure or - * value that represents the number of DNS records - * @param address On success, destination for the host SocketAddress. + *
+ * \c result : Negative error code on failure, or value that represents the number of DNS records + *
+ * \c address : On success, destination for the host SocketAddress. */ typedef mbed::Callback hostbyname_cb_t; diff --git a/connectivity/netsocket/include/netsocket/NetworkStack.h b/connectivity/netsocket/include/netsocket/NetworkStack.h index 37aab88..1c93355 100644 --- a/connectivity/netsocket/include/netsocket/NetworkStack.h +++ b/connectivity/netsocket/include/netsocket/NetworkStack.h @@ -110,21 +110,7 @@ */ virtual nsapi_value_or_error_t getaddrinfo(const char *hostname, SocketAddress *hints, SocketAddress **res, const char *interface_name = NULL); - /** Hostname translation callback (asynchronous) - * - * Callback will be called after DNS resolution completes or a failure occurs. - * - * Callback should not take more than 10ms to execute, otherwise it might - * prevent underlying thread processing. A portable user of the callback - * should not make calls to network operations due to stack size limitations. - * The callback should not perform expensive operations such as socket recv/send - * calls or blocking operations. - * - * @param result Negative error code on failure or - * value that represents the number of DNS records - * @param address On success, destination for the host SocketAddress - */ - typedef mbed::Callback hostbyname_cb_t; + typedef NetworkInterface::hostbyname_cb_t hostbyname_cb_t; /** Translates a hostname to multiple IP addresses (asynchronous) * diff --git a/connectivity/netsocket/include/netsocket/PPP.h b/connectivity/netsocket/include/netsocket/PPP.h index 1b25d4a..d80e50e 100644 --- a/connectivity/netsocket/include/netsocket/PPP.h +++ b/connectivity/netsocket/include/netsocket/PPP.h @@ -38,17 +38,15 @@ /** * Callback to be registered with PPP interface and to be called for received packets * - * @param buf Received data + *
\c buf : Received data */ - //typedef void (*ppp_link_input_fn)(void *data, net_stack_mem_buf_t *buf); typedef mbed::Callback ppp_link_input_cb_t; /** * Callback to be registered with PPP interface and to be called for link status changes * - * @param up Link status + *
\c up : Link status */ - //typedef void (*ppp_link_state_change_fn)(void *data, bool up); typedef mbed::Callback ppp_link_state_change_cb_t; /** diff --git a/connectivity/netsocket/include/netsocket/Socket.h b/connectivity/netsocket/include/netsocket/Socket.h index aee303c..62c3681 100644 --- a/connectivity/netsocket/include/netsocket/Socket.h +++ b/connectivity/netsocket/include/netsocket/Socket.h @@ -284,7 +284,7 @@ * @param optlen Length of the option value. * @retval NSAPI_ERROR_OK on success. * @retval NSAPI_ERROR_NO_SOCKET if socket is not open. - * @retval int Negative error code on failure, see @ref NetworkStack::setsockopt. + * @retval Negative error code on failure, see #NetworkStack::setsockopt */ virtual nsapi_error_t setsockopt(int level, int optname, const void *optval, unsigned optlen) = 0; @@ -303,7 +303,7 @@ * @param optlen Length of the option value. * @retval NSAPI_ERROR_OK on success. * @retval NSAPI_ERROR_NO_SOCKET if socket is not open. - * @retval int Negative error code on failure, see @ref NetworkStack::getsockopt. + * @retval Negative error code on failure, see #NetworkStack::getsockopt */ virtual nsapi_error_t getsockopt(int level, int optname, void *optval, unsigned *optlen) = 0; diff --git a/connectivity/netsocket/include/netsocket/nsapi_types.h b/connectivity/netsocket/include/netsocket/nsapi_types.h index 1703feb..8d37e05 100644 --- a/connectivity/netsocket/include/netsocket/nsapi_types.h +++ b/connectivity/netsocket/include/netsocket/nsapi_types.h @@ -442,7 +442,8 @@ typedef struct nsapi_stack_api { /** Get the local IP address * - * @param stack Stack handle + *
\c stack : Stack handle + * * @return Local IP Address or null address if not connected */ nsapi_addr_t (*get_ip_address)(nsapi_stack_t *stack); @@ -455,18 +456,20 @@ * If no stack-specific DNS resolution is provided, the hostname * will be resolve using a UDP socket on the stack. * - * @param stack Stack handle - * @param addr Destination for the host IP address - * @param host Hostname to resolve - * @param version Address family - * @return 0 on success, negative error code on failure + *
\c stack : Stack handle + *
\c addr : Destination for the host IP address + *
\c host : Hostname to resolve + *
\c version : Address family + * + * @return 0 on success, negative error code on failure */ nsapi_error_t (*gethostbyname)(nsapi_stack_t *stack, const char *host, nsapi_addr_t *addr, nsapi_version_t version); /** Add a domain name server to list of servers to query * - * @param addr Destination for the host address - * @return 0 on success, negative error code on failure + *
\c addr : Destination for the host address + * + * @return 0 on success, negative error code on failure */ nsapi_error_t (*add_dns_server)(nsapi_stack_t *stack, nsapi_addr_t addr); @@ -476,12 +479,13 @@ * to the underlying stack. For unsupported options, * NSAPI_ERROR_UNSUPPORTED is returned and the stack is unmodified. * - * @param stack Stack handle - * @param level Stack-specific protocol level - * @param optname Stack-specific option identifier - * @param optval Option value - * @param optlen Length of the option value - * @return 0 on success, negative error code on failure + *
\c stack : Stack handle + *
\c level : Stack-specific protocol level + *
\c optname : Stack-specific option identifier + *
\c optval : Option value + *
\c optlen : Length of the option value + * + * @return 0 on success, negative error code on failure */ nsapi_error_t (*setstackopt)(nsapi_stack_t *stack, int level, int optname, const void *optval, unsigned optlen); @@ -492,12 +496,13 @@ * from the underlying stack. For unsupported options, * NSAPI_ERROR_UNSUPPORTED is returned and optval is unmodified. * - * @param stack Stack handle - * @param level Stack-specific protocol level - * @param optname Stack-specific option identifier - * @param optval Destination for option value - * @param optlen Length of the option value - * @return 0 on success, negative error code on failure + *
\c stack : Stack handle + *
\c level : Stack-specific protocol level + *
\c optname : Stack-specific option identifier + *
\c optval : Destination for option value + *
\c optlen : Length of the option value + * + * @return 0 on success, negative error code on failure */ nsapi_error_t (*getstackopt)(nsapi_stack_t *stack, int level, int optname, void *optval, unsigned *optlen); @@ -510,10 +515,11 @@ * A stack may have a finite number of sockets, in this case * NSAPI_ERROR_NO_SOCKET is returned if no socket is available. * - * @param stack Stack context - * @param socket Destination for the handle to a newly created socket - * @param proto Protocol of socket to open, NSAPI_TCP or NSAPI_UDP - * @return 0 on success, negative error code on failure + *
\c stack : Stack context + *
\c socket : Destination for the handle to a newly created socket + *
\c proto : Protocol of socket to open, NSAPI_TCP or NSAPI_UDP + * + * @return 0 on success, negative error code on failure */ nsapi_error_t (*socket_open)(nsapi_stack_t *stack, nsapi_socket_t *socket, nsapi_protocol_t proto); @@ -523,9 +529,10 @@ * Closes any open connection and deallocates any memory associated * with the socket. * - * @param stack Stack handle - * @param socket Socket handle - * @return 0 on success, negative error code on failure + *
\c stack : Stack handle + *
\c socket : Socket handle + * + * @return 0 on success, negative error code on failure */ nsapi_error_t (*socket_close)(nsapi_stack_t *stack, nsapi_socket_t socket); @@ -534,11 +541,12 @@ * Binding a socket specifies the address and port on which to receive * data. If the IP address is zeroed, only the port is bound. * - * @param stack Stack handle - * @param socket Socket handle - * @param addr Local address to bind, may be null - * @param port Local port to bind - * @return 0 on success, negative error code on failure. + *
\c stack : Stack handle + *
\c socket : Socket handle + *
\c addr : Local address to bind, may be null + *
\c port : Local port to bind + * + * @return 0 on success, negative error code on failure. */ nsapi_error_t (*socket_bind)(nsapi_stack_t *stack, nsapi_socket_t socket, nsapi_addr_t addr, uint16_t port); @@ -548,11 +556,11 @@ * Marks the socket as a passive socket that can be used to accept * incoming connections. * - * @param stack Stack handle - * @param socket Socket handle - * @param backlog Number of pending connections that can be queued - * simultaneously - * @return 0 on success, negative error code on failure + *
\c stack : Stack handle + *
\c socket : Socket handle + *
\c backlog : Number of pending connections that can be queued simultaneously + * + * @return 0 on success, negative error code on failure */ nsapi_error_t (*socket_listen)(nsapi_stack_t *stack, nsapi_socket_t socket, int backlog); @@ -561,11 +569,12 @@ * Initiates a connection to a remote server specified by the * indicated address. * - * @param stack Stack handle - * @param socket Socket handle - * @param addr The address of the remote host - * @param port The port of the remote host - * @return 0 on success, negative error code on failure + *
\c stack : Stack handle + *
\c socket : Socket handle + *
\c addr : The address of the remote host + *
\c port : The port of the remote host + * + * @return 0 on success, negative error code on failure */ nsapi_error_t (*socket_connect)(nsapi_stack_t *stack, nsapi_socket_t socket, nsapi_addr_t addr, uint16_t port); @@ -583,12 +592,13 @@ * This call is non-blocking. If accept would block, * NSAPI_ERROR_WOULD_BLOCK is returned immediately. * - * @param stack Stack handle - * @param server Socket handle to server to accept from - * @param socket Destination for a handle to the newly created socket - * @param addr Destination for the address of the remote host - * @param port Destination for the port of the remote host - * @return 0 on success, negative error code on failure + *
\c stack : Stack handle + *
\c server : Socket handle to server to accept from + *
\c socket : Destination for a handle to the newly created socket + *
\c addr : Destination for the address of the remote host + *
\c port : Destination for the port of the remote host + * + * @return 0 on success, negative error code on failure */ nsapi_error_t (*socket_accept)(nsapi_stack_t *stack, nsapi_socket_t server, nsapi_socket_t *socket, nsapi_addr_t *addr, uint16_t *port); @@ -601,12 +611,12 @@ * This call is non-blocking. If send would block, * NSAPI_ERROR_WOULD_BLOCK is returned immediately. * - * @param stack Stack handle - * @param socket Socket handle - * @param data Buffer of data to send to the host - * @param size Size of the buffer in bytes - * @return Number of sent bytes on success, negative error - * code on failure + *
\c stack : Stack handle + *
\c socket : Socket handle + *
\c data : Buffer of data to send to the host + *
\c size : Size of the buffer in bytes + * + * @return Number of sent bytes on success, negative error code on failure */ nsapi_size_or_error_t (*socket_send)(nsapi_stack_t *stack, nsapi_socket_t socket, const void *data, nsapi_size_t size); @@ -619,12 +629,12 @@ * This call is non-blocking. If recv would block, * NSAPI_ERROR_WOULD_BLOCK is returned immediately. * - * @param stack Stack handle - * @param socket Socket handle - * @param data Destination buffer for data received from the host - * @param size Size of the buffer in bytes - * @return Number of received bytes on success, negative error - * code on failure + *
\c stack : Stack handle + *
\c socket : Socket handle + *
\c data : Destination buffer for data received from the host + *
\c size : Size of the buffer in bytes + * + * @return Number of received bytes on success, negative error code on failure */ nsapi_size_or_error_t (*socket_recv)(nsapi_stack_t *stack, nsapi_socket_t socket, void *data, nsapi_size_t size); @@ -637,14 +647,14 @@ * This call is non-blocking. If sendto would block, * NSAPI_ERROR_WOULD_BLOCK is returned immediately. * - * @param stack Stack handle - * @param socket Socket handle - * @param addr The address of the remote host - * @param port The port of the remote host - * @param data Buffer of data to send to the host - * @param size Size of the buffer in bytes - * @return Number of sent bytes on success, negative error - * code on failure + *
\c stack : Stack handle + *
\c socket : Socket handle + *
\c addr : The address of the remote host + *
\c port : The port of the remote host + *
\c data : Buffer of data to send to the host + *
\c size : Size of the buffer in bytes + * + * @return Number of sent bytes on success, negative error code on failure */ nsapi_size_or_error_t (*socket_sendto)(nsapi_stack_t *stack, nsapi_socket_t socket, nsapi_addr_t addr, uint16_t port, const void *data, nsapi_size_t size); @@ -657,14 +667,14 @@ * This call is non-blocking. If recvfrom would block, * NSAPI_ERROR_WOULD_BLOCK is returned immediately. * - * @param stack Stack handle - * @param socket Socket handle - * @param addr Destination for the address of the remote host - * @param port Destination for the port of the remote host - * @param data Destination buffer for data received from the host - * @param size Size of the buffer in bytes - * @return Number of received bytes on success, negative error - * code on failure + *
\c stack : Stack handle + *
\c socket : Socket handle + *
\c addr : Destination for the address of the remote host + *
\c port : Destination for the port of the remote host + *
\c data : Destination buffer for data received from the host + *
\c size : Size of the buffer in bytes + * + * @return Number of received bytes on success, negative error code on failure */ nsapi_size_or_error_t (*socket_recvfrom)(nsapi_stack_t *stack, nsapi_socket_t socket, nsapi_addr_t *addr, uint16_t *port, void *buffer, nsapi_size_t size); @@ -689,10 +699,10 @@ * The callback may be called in an interrupt context and should not * perform expensive operations such as recv/send calls. * - * @param stack Stack handle - * @param socket Socket handle - * @param callback Function to call on state change - * @param data Argument to pass to callback + *
\c stack : Stack handle + *
\c socket : Socket handle + *
\c callback : Function to call on state change + *
\c data : Argument to pass to callback */ void (*socket_attach)(nsapi_stack_t *stack, nsapi_socket_t socket, void (*callback)(void *), void *data); @@ -703,13 +713,14 @@ * to the underlying stack. For unsupported options, * NSAPI_ERROR_UNSUPPORTED is returned and the socket is unmodified. * - * @param stack Stack handle - * @param socket Socket handle - * @param level Stack-specific protocol level - * @param optname Stack-specific option identifier - * @param optval Option value - * @param optlen Length of the option value - * @return 0 on success, negative error code on failure + *
\c stack : Stack handle + *
\c socket : Socket handle + *
\c level : Stack-specific protocol level + *
\c optname : Stack-specific option identifier + *
\c optval : Option value + *
\c optlen : Length of the option value + * + * @return 0 on success, negative error code on failure */ nsapi_error_t (*setsockopt)(nsapi_stack_t *stack, nsapi_socket_t socket, int level, int optname, const void *optval, unsigned optlen); @@ -720,13 +731,14 @@ * from the underlying stack. For unsupported options, * NSAPI_ERROR_UNSUPPORTED is returned and optval is unmodified. * - * @param stack Stack handle - * @param socket Socket handle - * @param level Stack-specific protocol level - * @param optname Stack-specific option identifier - * @param optval Destination for option value - * @param optlen Length of the option value - * @return 0 on success, negative error code on failure + *
\c stack : Stack handle + *
\c socket : Socket handle + *
\c level : Stack-specific protocol level + *
\c optname : Stack-specific option identifier + *
\c optval : Destination for option value + *
\c optlen : Length of the option value + * + * @return 0 on success, negative error code on failure */ nsapi_error_t (*getsockopt)(nsapi_stack_t *stack, nsapi_socket_t socket, int level, int optname, void *optval, unsigned *optlen); diff --git a/doxyfile_options b/doxyfile_options index cfa554b..9efa5c1 100644 --- a/doxyfile_options +++ b/doxyfile_options @@ -1,4 +1,4 @@ -# Doxyfile 1.9.1 +# Doxyfile 1.9.5 # This file describes the settings to be used by the documentation system # doxygen (www.doxygen.org) for a project. @@ -12,6 +12,16 @@ # For lists, items can also be appended using: # TAG += value [value, ...] # Values that contain spaces should be placed between quotes (\" \"). +# +# Note: +# +# Use doxygen to compare the used configuration file with the template +# configuration file: +# doxygen -x [configFile] +# Use doxygen to compare the used configuration file with the template +# configuration file without replacing the environment variables or CMake type +# replacement variables: +# doxygen -x_noenv [configFile] #--------------------------------------------------------------------------- # Project related configuration options @@ -60,16 +70,28 @@ OUTPUT_DIRECTORY = -# If the CREATE_SUBDIRS tag is set to YES then doxygen will create 4096 sub- -# directories (in 2 levels) under the output directory of each output format and -# will distribute the generated files over these directories. Enabling this +# If the CREATE_SUBDIRS tag is set to YES then doxygen will create up to 4096 +# sub-directories (in 2 levels) under the output directory of each output format +# and will distribute the generated files over these directories. Enabling this # option can be useful when feeding doxygen a huge amount of source files, where # putting all generated files in the same directory would otherwise causes -# performance problems for the file system. +# performance problems for the file system. Adapt CREATE_SUBDIRS_LEVEL to +# control the number of sub-directories. # The default value is: NO. CREATE_SUBDIRS = NO +# Controls the number of sub-directories that will be created when +# CREATE_SUBDIRS tag is set to YES. Level 0 represents 16 directories, and every +# level increment doubles the number of directories, resulting in 4096 +# directories at level 8 which is the default and also the maximum value. The +# sub-directories are organized in 2 levels, the first level always has a fixed +# numer of 16 directories. +# Minimum value: 0, maximum value: 8, default value: 8. +# This tag requires that the tag CREATE_SUBDIRS is set to YES. + +CREATE_SUBDIRS_LEVEL = 8 + # If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII # characters to appear in the names of generated files. If set to NO, non-ASCII # characters will be escaped, for example _xE3_x81_x84 will be used for Unicode @@ -81,26 +103,18 @@ # The OUTPUT_LANGUAGE tag is used to specify the language in which all # documentation generated by doxygen is written. Doxygen will use this # information to generate all constant output in the proper language. -# Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese, -# Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States), -# Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian, -# Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages), -# Korean, Korean-en (Korean with English messages), Latvian, Lithuanian, -# Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian, -# Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish, -# Ukrainian and Vietnamese. +# Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Bulgarian, +# Catalan, Chinese, Chinese-Traditional, Croatian, Czech, Danish, Dutch, English +# (United States), Esperanto, Farsi (Persian), Finnish, French, German, Greek, +# Hindi, Hungarian, Indonesian, Italian, Japanese, Japanese-en (Japanese with +# English messages), Korean, Korean-en (Korean with English messages), Latvian, +# Lithuanian, Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, +# Romanian, Russian, Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, +# Swedish, Turkish, Ukrainian and Vietnamese. # The default value is: English. OUTPUT_LANGUAGE = English -# The OUTPUT_TEXT_DIRECTION tag is used to specify the direction in which all -# documentation generated by doxygen is written. Doxygen will use this -# information to generate all generated output in the proper direction. -# Possible values are: None, LTR, RTL and Context. -# The default value is: None. - -OUTPUT_TEXT_DIRECTION = None - # If the BRIEF_MEMBER_DESC tag is set to YES, doxygen will include brief member # descriptions after the members that are listed in the file and class # documentation (similar to Javadoc). Set to NO to disable this. @@ -248,16 +262,16 @@ # the documentation. An alias has the form: # name=value # For example adding -# "sideeffect=@par Side Effects:\n" +# "sideeffect=@par Side Effects:^^" # will allow you to put the command \sideeffect (or @sideeffect) in the # documentation, which will result in a user-defined paragraph with heading -# "Side Effects:". You can put \n's in the value part of an alias to insert -# newlines (in the resulting output). You can put ^^ in the value part of an -# alias to insert a newline as if a physical newline was in the original file. -# When you need a literal { or } or , in the value part of an alias you have to -# escape them by means of a backslash (\), this can lead to conflicts with the -# commands \{ and \} for these it is advised to use the version @{ and @} or use -# a double escape (\\{ and \\}) +# "Side Effects:". Note that you cannot put \n's in the value part of an alias +# to insert newlines (in the resulting output). You can put ^^ in the value part +# of an alias to insert a newline as if a physical newline was in the original +# file. When you need a literal { or } or , in the value part of an alias you +# have to escape them by means of a backslash (\), this can lead to conflicts +# with the commands \{ and \} for these it is advised to use the version @{ and +# @} or use a double escape (\\{ and \\}) ALIASES = @@ -302,8 +316,8 @@ # extension. Doxygen has a built-in mapping, but you can override or extend it # using this tag. The format is ext=language, where ext is a file extension, and # language is one of the parsers supported by doxygen: IDL, Java, JavaScript, -# Csharp (C#), C, C++, D, PHP, md (Markdown), Objective-C, Python, Slice, VHDL, -# Fortran (fixed format Fortran: FortranFixed, free formatted Fortran: +# Csharp (C#), C, C++, Lex, D, PHP, md (Markdown), Objective-C, Python, Slice, +# VHDL, Fortran (fixed format Fortran: FortranFixed, free formatted Fortran: # FortranFree, unknown formatted Fortran: Fortran. In the later case the parser # tries to guess whether the code is fixed or free formatted code, this is the # default for Fortran type files). For instance to make doxygen treat .inc files @@ -450,13 +464,13 @@ LOOKUP_CACHE_SIZE = 0 -# The NUM_PROC_THREADS specifies the number threads doxygen is allowed to use +# The NUM_PROC_THREADS specifies the number of threads doxygen is allowed to use # during processing. When set to 0 doxygen will based this on the number of # cores available in the system. You can set it explicitly to a value larger # than 0 to get more control over the balance between CPU load and processing # speed. At this moment only the input processing can be done using multiple # threads. Since this is still an experimental feature the default is set to 1, -# which efficively disables parallel processing. Please report any issues you +# which effectively disables parallel processing. Please report any issues you # encounter. Generating dot graphs in parallel is controlled by the # DOT_NUM_THREADS setting. # Minimum value: 0, maximum value: 32, default value: 1. @@ -575,14 +589,15 @@ # filesystem is case sensitive (i.e. it supports files in the same directory # whose names only differ in casing), the option must be set to YES to properly # deal with such files in case they appear in the input. For filesystems that -# are not case sensitive the option should be be set to NO to properly deal with +# are not case sensitive the option should be set to NO to properly deal with # output files written for symbols that only differ in casing, such as for two # classes, one named CLASS and the other named Class, and to also support # references to files without having to specify the exact matching casing. On # Windows (including Cygwin) and MacOS, users should typically set this option # to NO, whereas on Linux or other Unix flavors it should typically be set to # YES. -# The default value is: system dependent. +# Possible values are: SYSTEM, NO and YES. +# The default value is: SYSTEM. CASE_SENSE_NAMES = NO @@ -600,6 +615,12 @@ HIDE_COMPOUND_REFERENCE= NO +# If the SHOW_HEADERFILE tag is set to YES then the documentation for a class +# will show which file needs to be included to use the class. +# The default value is: YES. + +SHOW_HEADERFILE = YES + # If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of # the files that are included by a file in the documentation of that file. # The default value is: YES. @@ -757,7 +778,8 @@ # output files in an output format independent way. To create the layout file # that represents doxygen's defaults, run doxygen with the -l option. You can # optionally specify a file name after the option, if omitted DoxygenLayout.xml -# will be used as the name of the layout file. +# will be used as the name of the layout file. See also section "Changing the +# layout of pages" for information. # # Note that if you run doxygen from a directory containing a file called # DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE @@ -803,18 +825,26 @@ WARN_IF_UNDOCUMENTED = NO # If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for -# potential errors in the documentation, such as not documenting some parameters -# in a documented function, or documenting parameters that don't exist or using -# markup commands wrongly. +# potential errors in the documentation, such as documenting some parameters in +# a documented function twice, or documenting parameters that don't exist or +# using markup commands wrongly. # The default value is: YES. WARN_IF_DOC_ERROR = YES +# If WARN_IF_INCOMPLETE_DOC is set to YES, doxygen will warn about incomplete +# function parameter documentation. If set to NO, doxygen will accept that some +# parameters have no documentation without warning. +# The default value is: YES. + +WARN_IF_INCOMPLETE_DOC = YES + # This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that # are documented, but have no documentation for their parameters or return -# value. If set to NO, doxygen will only warn about wrong or incomplete -# parameter documentation, but not about the absence of documentation. If -# EXTRACT_ALL is set to YES then this flag will automatically be disabled. +# value. If set to NO, doxygen will only warn about wrong parameter +# documentation, but not about the absence of documentation. If EXTRACT_ALL is +# set to YES then this flag will automatically be disabled. See also +# WARN_IF_INCOMPLETE_DOC # The default value is: NO. WARN_NO_PARAMDOC = NO @@ -834,13 +864,27 @@ # and the warning text. Optionally the format may contain $version, which will # be replaced by the version of the file (if it could be obtained via # FILE_VERSION_FILTER) +# See also: WARN_LINE_FORMAT # The default value is: $file:$line: $text. WARN_FORMAT = "$file:$line: $text" +# In the $text part of the WARN_FORMAT command it is possible that a reference +# to a more specific place is given. To make it easier to jump to this place +# (outside of doxygen) the user can define a custom "cut" / "paste" string. +# Example: +# WARN_LINE_FORMAT = "'vi $file +$line'" +# See also: WARN_FORMAT +# The default value is: at line $line of file $file. + +WARN_LINE_FORMAT = "at line $line of file $file" + # The WARN_LOGFILE tag can be used to specify a file to which warning and error # messages should be written. If left blank the output is written to standard -# error (stderr). +# error (stderr). In case the file specified cannot be opened for writing the +# warning and error messages are written to standard error. When as file - is +# specified the warning and error messages are written to standard output +# (stdout). WARN_LOGFILE = @@ -861,10 +905,21 @@ # libiconv (or the iconv built into libc) for the transcoding. See the libiconv # documentation (see: # https://www.gnu.org/software/libiconv/) for the list of possible encodings. +# See also: INPUT_FILE_ENCODING # The default value is: UTF-8. INPUT_ENCODING = UTF-8 +# This tag can be used to specify the character encoding of the source files +# that doxygen parses The INPUT_FILE_ENCODING tag can be used to specify +# character encoding on a per file pattern basis. Doxygen will compare the file +# name with each pattern and apply the encoding instead of the default +# INPUT_ENCODING) if there is a match. The character encodings are a list of the +# form: pattern=encoding (like *.php=ISO-8859-1). See cfg_input_encoding +# "INPUT_ENCODING" for further information on supported encodings. + +INPUT_FILE_ENCODING = + # If the value of the INPUT tag contains directories, you can use the # FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and # *.h) to filter out the source-files in the directories. @@ -878,10 +933,10 @@ # # If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cpp, # *.c++, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, -# *.hh, *.hxx, *.hpp, *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, -# *.m, *.markdown, *.md, *.mm, *.dox (to be provided as doxygen C comment), -# *.py, *.pyw, *.f90, *.f95, *.f03, *.f08, *.f18, *.f, *.for, *.vhd, *.vhdl, -# *.ucf, *.qsf and *.ice. +# *.hh, *.hxx, *.hpp, *.h++, *.l, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, +# *.inc, *.m, *.markdown, *.md, *.mm, *.dox (to be provided as doxygen C +# comment), *.py, *.pyw, *.f90, *.f95, *.f03, *.f08, *.f18, *.f, *.for, *.vhd, +# *.vhdl, *.ucf, *.qsf and *.ice. FILE_PATTERNS = *.h \ DOXYGEN_FRONTPAGE.md @@ -954,7 +1009,7 @@ # (namespaces, classes, functions, etc.) that should be excluded from the # output. The symbol name can be a fully qualified name, a word, or if the # wildcard * is used, a substring. Examples: ANamespace, AClass, -# AClass::ANamespace, ANamespace::*Test +# ANamespace::AClass, ANamespace::*Test # # Note that the wildcards are matched against the file with absolute path, so to # exclude all test directories use the pattern */test/* @@ -1002,6 +1057,11 @@ # code is scanned, but not when the output code is generated. If lines are added # or removed, the anchors will not be placed correctly. # +# Note that doxygen will use the data processed and written to standard output +# for further processing, therefore nothing else, like debug statements or used +# commands (so in case of a Windows batch file always use @echo OFF), should be +# written to standard output. +# # Note that for custom extensions or not directly supported extensions you also # need to set EXTENSION_MAPPING for the extension otherwise the files are not # properly processed by doxygen. @@ -1043,6 +1103,15 @@ USE_MDFILE_AS_MAINPAGE = DOXYGEN_FRONTPAGE.md +# The Fortran standard specifies that for fixed formatted Fortran code all +# characters from position 72 are to be considered as comment. A common +# extension is to allow longer lines before the automatic comment starts. The +# setting FORTRAN_COMMENT_AFTER will also make it possible that longer lines can +# be processed before the automatic comment starts. +# Minimum value: 7, maximum value: 10000, default value: 72. + +FORTRAN_COMMENT_AFTER = 72 + #--------------------------------------------------------------------------- # Configuration options related to source browsing #--------------------------------------------------------------------------- @@ -1238,9 +1307,26 @@ HTML_EXTRA_FILES = +# The HTML_COLORSTYLE tag can be used to specify if the generated HTML output +# should be rendered with a dark or light theme. Default setting AUTO_LIGHT +# enables light output unless the user preference is dark output. Other options +# are DARK to always use dark mode, LIGHT to always use light mode, AUTO_DARK to +# default to dark mode unless the user prefers light mode, and TOGGLE to let the +# user toggle between dark and light mode via a button. +# Possible values are: LIGHT Always generate light output., DARK Always generate +# dark output., AUTO_LIGHT Automatically set the mode according to the user +# preference, use light mode if no preference is set (the default)., AUTO_DARK +# Automatically set the mode according to the user preference, use dark mode if +# no preference is set. and TOGGLE Allow to user to switch between light and +# dark mode via a button.. +# The default value is: AUTO_LIGHT. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE = AUTO_LIGHT + # The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen # will adjust the colors in the style sheet and background images according to -# this color. Hue is specified as an angle on a colorwheel, see +# this color. Hue is specified as an angle on a color-wheel, see # https://en.wikipedia.org/wiki/Hue for more information. For instance the value # 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300 # purple, and 360 is red again. @@ -1250,7 +1336,7 @@ HTML_COLORSTYLE_HUE = 220 # The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors -# in the HTML output. For a value of 0 the output will use grayscales only. A +# in the HTML output. For a value of 0 the output will use gray-scales only. A # value of 255 will produce the most vivid colors. # Minimum value: 0, maximum value: 255, default value: 100. # This tag requires that the tag GENERATE_HTML is set to YES. @@ -1332,6 +1418,13 @@ DOCSET_FEEDNAME = "Doxygen generated docs" +# This tag determines the URL of the docset feed. A documentation feed provides +# an umbrella under which multiple documentation sets from a single provider +# (such as a company or product suite) can be grouped. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_FEEDURL = + # This tag specifies a string that should uniquely identify the documentation # set bundle. This should be a reverse domain-name style string, e.g. # com.mycompany.MyDocSet. Doxygen will append .docset to the name. @@ -1357,8 +1450,12 @@ # If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three # additional HTML index files: index.hhp, index.hhc, and index.hhk. The # index.hhp is a project file that can be read by Microsoft's HTML Help Workshop -# (see: -# https://www.microsoft.com/en-us/download/details.aspx?id=21138) on Windows. +# on Windows. In the beginning of 2021 Microsoft took the original page, with +# a.o. the download links, offline the HTML help workshop was already many years +# in maintenance mode). You can download the HTML help workshop from the web +# archives at Installation executable (see: +# http://web.archive.org/web/20160201063255/http://download.microsoft.com/downlo +# ad/0/A/9/0A939EF6-E31C-430F-A3DF-DFAE7960D564/htmlhelp.exe). # # The HTML Help Workshop contains a compiler that can convert all HTML output # generated by doxygen into a single compiled HTML file (.chm). Compiled HTML @@ -1517,16 +1614,28 @@ # to work a browser that supports JavaScript, DHTML, CSS and frames is required # (i.e. any modern browser). Windows users are probably better off using the # HTML help feature. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can -# further fine-tune the look of the index. As an example, the default style -# sheet generated by doxygen has an example that shows how to put an image at -# the root of the tree instead of the PROJECT_NAME. Since the tree basically has -# the same information as the tab index, you could consider setting -# DISABLE_INDEX to YES when enabling this option. +# further fine tune the look of the index (see "Fine-tuning the output"). As an +# example, the default style sheet generated by doxygen has an example that +# shows how to put an image at the root of the tree instead of the PROJECT_NAME. +# Since the tree basically has the same information as the tab index, you could +# consider setting DISABLE_INDEX to YES when enabling this option. # The default value is: NO. # This tag requires that the tag GENERATE_HTML is set to YES. GENERATE_TREEVIEW = YES +# When both GENERATE_TREEVIEW and DISABLE_INDEX are set to YES, then the +# FULL_SIDEBAR option determines if the side bar is limited to only the treeview +# area (value NO) or if it should extend to the full height of the window (value +# YES). Setting this to YES gives a layout similar to +# https://docs.readthedocs.io with more room for contents, but less room for the +# project logo, title, and description. If either GENERATE_TREEVIEW or +# DISABLE_INDEX is set to NO, this option has no effect. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +FULL_SIDEBAR = NO + # The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that # doxygen will group on one line in the generated HTML documentation. # @@ -1551,6 +1660,13 @@ EXT_LINKS_IN_WINDOW = NO +# If the OBFUSCATE_EMAILS tag is set to YES, doxygen will obfuscate email +# addresses. +# The default value is: YES. +# This tag requires that the tag GENERATE_HTML is set to YES. + +OBFUSCATE_EMAILS = YES + # If the HTML_FORMULA_FORMAT option is set to svg, doxygen will use the pdf2svg # tool (see https://github.com/dawbarton/pdf2svg) or inkscape (see # https://inkscape.org) to generate formulas as SVG images instead of PNGs for @@ -1571,17 +1687,6 @@ FORMULA_FONTSIZE = 10 -# Use the FORMULA_TRANSPARENT tag to determine whether or not the images -# generated for formulas are transparent PNGs. Transparent PNGs are not -# supported properly for IE 6.0, but are supported on all modern browsers. -# -# Note that when changing this option you need to delete any form_*.png files in -# the HTML output directory before the changes have effect. -# The default value is: YES. -# This tag requires that the tag GENERATE_HTML is set to YES. - -FORMULA_TRANSPARENT = YES - # The FORMULA_MACROFILE can contain LaTeX \newcommand and \renewcommand commands # to create new LaTeX commands to be used in formulas as building blocks. See # the section "Including formulas" for details. @@ -1599,11 +1704,29 @@ USE_MATHJAX = NO +# With MATHJAX_VERSION it is possible to specify the MathJax version to be used. +# Note that the different versions of MathJax have different requirements with +# regards to the different settings, so it is possible that also other MathJax +# settings have to be changed when switching between the different MathJax +# versions. +# Possible values are: MathJax_2 and MathJax_3. +# The default value is: MathJax_2. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_VERSION = MathJax_2 + # When MathJax is enabled you can set the default output format to be used for -# the MathJax output. See the MathJax site (see: -# http://docs.mathjax.org/en/v2.7-latest/output.html) for more details. +# the MathJax output. For more details about the output format see MathJax +# version 2 (see: +# http://docs.mathjax.org/en/v2.7-latest/output.html) and MathJax version 3 +# (see: +# http://docs.mathjax.org/en/latest/web/components/output.html). # Possible values are: HTML-CSS (which is slower, but has the best -# compatibility), NativeMML (i.e. MathML) and SVG. +# compatibility. This is the name for Mathjax version 2, for MathJax version 3 +# this will be translated into chtml), NativeMML (i.e. MathML. Only supported +# for NathJax 2. For MathJax version 3 chtml will be used instead.), chtml (This +# is the name for Mathjax version 3, for MathJax version 2 this will be +# translated into HTML-CSS) and SVG. # The default value is: HTML-CSS. # This tag requires that the tag USE_MATHJAX is set to YES. @@ -1616,15 +1739,21 @@ # MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax # Content Delivery Network so you can quickly see the result without installing # MathJax. However, it is strongly recommended to install a local copy of -# MathJax from https://www.mathjax.org before deployment. -# The default value is: https://cdn.jsdelivr.net/npm/mathjax@2. +# MathJax from https://www.mathjax.org before deployment. The default value is: +# - in case of MathJax version 2: https://cdn.jsdelivr.net/npm/mathjax@2 +# - in case of MathJax version 3: https://cdn.jsdelivr.net/npm/mathjax@3 # This tag requires that the tag USE_MATHJAX is set to YES. MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest # The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax # extension names that should be enabled during MathJax rendering. For example +# for MathJax version 2 (see +# https://docs.mathjax.org/en/v2.7-latest/tex.html#tex-and-latex-extensions): # MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols +# For example for MathJax version 3 (see +# http://docs.mathjax.org/en/latest/input/tex/extensions/index.html): +# MATHJAX_EXTENSIONS = ams # This tag requires that the tag USE_MATHJAX is set to YES. MATHJAX_EXTENSIONS = @@ -1804,29 +1933,31 @@ EXTRA_PACKAGES = -# The LATEX_HEADER tag can be used to specify a personal LaTeX header for the -# generated LaTeX document. The header should contain everything until the first -# chapter. If it is left blank doxygen will generate a standard header. See -# section "Doxygen usage" for information on how to let doxygen write the -# default header to a separate file. +# The LATEX_HEADER tag can be used to specify a user-defined LaTeX header for +# the generated LaTeX document. The header should contain everything until the +# first chapter. If it is left blank doxygen will generate a standard header. It +# is highly recommended to start with a default header using +# doxygen -w latex new_header.tex new_footer.tex new_stylesheet.sty +# and then modify the file new_header.tex. See also section "Doxygen usage" for +# information on how to generate the default header that doxygen normally uses. # -# Note: Only use a user-defined header if you know what you are doing! The -# following commands have a special meaning inside the header: $title, -# $datetime, $date, $doxygenversion, $projectname, $projectnumber, -# $projectbrief, $projectlogo. Doxygen will replace $title with the empty -# string, for the replacement values of the other commands the user is referred -# to HTML_HEADER. +# Note: Only use a user-defined header if you know what you are doing! +# Note: The header is subject to change so you typically have to regenerate the +# default header when upgrading to a newer version of doxygen. The following +# commands have a special meaning inside the header (and footer): For a +# description of the possible markers and block names see the documentation. # This tag requires that the tag GENERATE_LATEX is set to YES. LATEX_HEADER = -# The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for the -# generated LaTeX document. The footer should contain everything after the last -# chapter. If it is left blank doxygen will generate a standard footer. See +# The LATEX_FOOTER tag can be used to specify a user-defined LaTeX footer for +# the generated LaTeX document. The footer should contain everything after the +# last chapter. If it is left blank doxygen will generate a standard footer. See # LATEX_HEADER for more information on how to generate a default footer and what -# special commands can be used inside the footer. -# -# Note: Only use a user-defined footer if you know what you are doing! +# special commands can be used inside the footer. See also section "Doxygen +# usage" for information on how to generate the default footer that doxygen +# normally uses. Note: Only use a user-defined footer if you know what you are +# doing! # This tag requires that the tag GENERATE_LATEX is set to YES. LATEX_FOOTER = @@ -1871,8 +2002,7 @@ # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \batchmode # command to the generated LaTeX files. This will instruct LaTeX to keep running -# if errors occur, instead of asking the user for help. This option is also used -# when generating formulas in HTML. +# if errors occur, instead of asking the user for help. # The default value is: NO. # This tag requires that the tag GENERATE_LATEX is set to YES. @@ -1885,16 +2015,6 @@ LATEX_HIDE_INDICES = NO -# If the LATEX_SOURCE_CODE tag is set to YES then doxygen will include source -# code with syntax highlighting in the LaTeX output. -# -# Note that which sources are shown also depends on other settings such as -# SOURCE_BROWSER. -# The default value is: NO. -# This tag requires that the tag GENERATE_LATEX is set to YES. - -LATEX_SOURCE_CODE = NO - # The LATEX_BIB_STYLE tag can be used to specify the style to use for the # bibliography, e.g. plainnat, or ieeetr. See # https://en.wikipedia.org/wiki/BibTeX and \cite for more info. @@ -1975,16 +2095,6 @@ RTF_EXTENSIONS_FILE = -# If the RTF_SOURCE_CODE tag is set to YES then doxygen will include source code -# with syntax highlighting in the RTF output. -# -# Note that which sources are shown also depends on other settings such as -# SOURCE_BROWSER. -# The default value is: NO. -# This tag requires that the tag GENERATE_RTF is set to YES. - -RTF_SOURCE_CODE = NO - #--------------------------------------------------------------------------- # Configuration options related to the man page output #--------------------------------------------------------------------------- @@ -2081,15 +2191,6 @@ DOCBOOK_OUTPUT = docbook -# If the DOCBOOK_PROGRAMLISTING tag is set to YES, doxygen will include the -# program listings (including syntax highlighting and cross-referencing -# information) to the DOCBOOK output. Note that enabling this will significantly -# increase the size of the DOCBOOK output. -# The default value is: NO. -# This tag requires that the tag GENERATE_DOCBOOK is set to YES. - -DOCBOOK_PROGRAMLISTING = NO - #--------------------------------------------------------------------------- # Configuration options for the AutoGen Definitions output #--------------------------------------------------------------------------- @@ -2176,7 +2277,8 @@ # The INCLUDE_PATH tag can be used to specify one or more directories that # contain include files that are not input files but should be processed by the -# preprocessor. +# preprocessor. Note that the INCLUDE_PATH is not recursive, so the setting of +# RECURSIVE has no effect here. # This tag requires that the tag SEARCH_INCLUDES is set to YES. INCLUDE_PATH = @@ -2232,11 +2334,11 @@ DEVICE_WATCHDOG \ DEVICE_LOCALFILESYSTEM \ TFM_LVL=1 \ - MBEDTLS_ENTROPY_C\ - MBEDTLS_CIPHER_MODE_CTR\ - MBEDTLS_CMAC_C\ - MBEDTLS_VERSION_C\ - DEVICEKEY_ENABLED\ + MBEDTLS_ENTROPY_C \ + MBEDTLS_CIPHER_MODE_CTR \ + MBEDTLS_CMAC_C \ + MBEDTLS_VERSION_C \ + DEVICEKEY_ENABLED \ "MBED_DEPRECATED_SINCE(d, m)=" \ "MBED_ENABLE_IF_CALLBACK_COMPATIBLE(F, M)=" \ MBED_DEPRECATED(s)= \ @@ -2324,15 +2426,6 @@ # Configuration options related to the dot tool #--------------------------------------------------------------------------- -# If the CLASS_DIAGRAMS tag is set to YES, doxygen will generate a class diagram -# (in HTML and LaTeX) for classes with base or super classes. Setting the tag to -# NO turns the diagrams off. Note that this option also works with HAVE_DOT -# disabled, but it is recommended to install and use dot, since it yields more -# powerful graphs. -# The default value is: YES. - -CLASS_DIAGRAMS = YES - # You can include diagrams made with dia in doxygen documentation. Doxygen will # then run dia to produce the diagram and insert it in the documentation. The # DIA_PATH tag allows you to specify the directory where the dia binary resides. @@ -2365,35 +2458,50 @@ DOT_NUM_THREADS = 0 -# When you want a differently looking font in the dot files that doxygen -# generates you can specify the font name using DOT_FONTNAME. You need to make -# sure dot is able to find the font, which can be done by putting it in a -# standard location or by setting the DOTFONTPATH environment variable or by -# setting DOT_FONTPATH to the directory containing the font. -# The default value is: Helvetica. +# DOT_COMMON_ATTR is common attributes for nodes, edges and labels of +# subgraphs. When you want a differently looking font in the dot files that +# doxygen generates you can specify fontname, fontcolor and fontsize attributes. +# For details please see Node, +# Edge and Graph Attributes specification You need to make sure dot is able +# to find the font, which can be done by putting it in a standard location or by +# setting the DOTFONTPATH environment variable or by setting DOT_FONTPATH to the +# directory containing the font. Default graphviz fontsize is 14. +# The default value is: fontname=Helvetica,fontsize=10. # This tag requires that the tag HAVE_DOT is set to YES. -DOT_FONTNAME = Helvetica +DOT_COMMON_ATTR = "fontname=Helvetica,fontsize=10" -# The DOT_FONTSIZE tag can be used to set the size (in points) of the font of -# dot graphs. -# Minimum value: 4, maximum value: 24, default value: 10. +# DOT_EDGE_ATTR is concatenated with DOT_COMMON_ATTR. For elegant style you can +# add 'arrowhead=open, arrowtail=open, arrowsize=0.5'. Complete documentation about +# arrows shapes. +# The default value is: labelfontname=Helvetica,labelfontsize=10. # This tag requires that the tag HAVE_DOT is set to YES. -DOT_FONTSIZE = 10 +DOT_EDGE_ATTR = "labelfontname=Helvetica,labelfontsize=10" -# By default doxygen will tell dot to use the default font as specified with -# DOT_FONTNAME. If you specify a different font using DOT_FONTNAME you can set -# the path where dot can find it using this tag. +# DOT_NODE_ATTR is concatenated with DOT_COMMON_ATTR. For view without boxes +# around nodes set 'shape=plain' or 'shape=plaintext' Shapes specification +# The default value is: shape=box,height=0.2,width=0.4. +# This tag requires that the tag HAVE_DOT is set to YES. + +DOT_NODE_ATTR = "shape=box,height=0.2,width=0.4" + +# You can set the path where dot can find font specified with fontname in +# DOT_COMMON_ATTR and others dot attributes. # This tag requires that the tag HAVE_DOT is set to YES. DOT_FONTPATH = -# If the CLASS_GRAPH tag is set to YES then doxygen will generate a graph for -# each documented class showing the direct and indirect inheritance relations. -# Setting this tag to YES will force the CLASS_DIAGRAMS tag to NO. +# If the CLASS_GRAPH tag is set to YES (or GRAPH) then doxygen will generate a +# graph for each documented class showing the direct and indirect inheritance +# relations. In case HAVE_DOT is set as well dot will be used to draw the graph, +# otherwise the built-in generator will be used. If the CLASS_GRAPH tag is set +# to TEXT the direct and indirect inheritance relations will be shown as texts / +# links. +# Possible values are: NO, YES, TEXT and GRAPH. # The default value is: YES. -# This tag requires that the tag HAVE_DOT is set to YES. CLASS_GRAPH = YES @@ -2407,7 +2515,8 @@ COLLABORATION_GRAPH = YES # If the GROUP_GRAPHS tag is set to YES then doxygen will generate a graph for -# groups, showing the direct groups dependencies. +# groups, showing the direct groups dependencies. See also the chapter Grouping +# in the manual. # The default value is: YES. # This tag requires that the tag HAVE_DOT is set to YES. @@ -2522,6 +2631,13 @@ DIRECTORY_GRAPH = YES +# The DIR_GRAPH_MAX_DEPTH tag can be used to limit the maximum number of levels +# of child directories generated in directory dependency graphs by dot. +# Minimum value: 1, maximum value: 25, default value: 1. +# This tag requires that the tag DIRECTORY_GRAPH is set to YES. + +DIR_GRAPH_MAX_DEPTH = 1 + # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images # generated by dot. For an explanation of the image formats see the section # output formats in the documentation of the dot tool (Graphviz (see: @@ -2575,10 +2691,10 @@ DIAFILE_DIRS = # When using plantuml, the PLANTUML_JAR_PATH tag should be used to specify the -# path where java can find the plantuml.jar file. If left blank, it is assumed -# PlantUML is not used or called during a preprocessing step. Doxygen will -# generate a warning when it encounters a \startuml command in this case and -# will not generate output for the diagram. +# path where java can find the plantuml.jar file or to the filename of jar file +# to be used. If left blank, it is assumed PlantUML is not used or called during +# a preprocessing step. Doxygen will generate a warning when it encounters a +# \startuml command in this case and will not generate output for the diagram. PLANTUML_JAR_PATH = @@ -2616,18 +2732,6 @@ MAX_DOT_GRAPH_DEPTH = 0 -# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent -# background. This is disabled by default, because dot on Windows does not seem -# to support this out of the box. -# -# Warning: Depending on the platform used, enabling this option may lead to -# badly anti-aliased labels on the edges of a graph (i.e. they become hard to -# read). -# The default value is: NO. -# This tag requires that the tag HAVE_DOT is set to YES. - -DOT_TRANSPARENT = NO - # Set the DOT_MULTI_TARGETS tag to YES to allow dot to generate multiple output # files in one run (i.e. multiple -o and -T options on the command line). This # makes dot run faster, but since only newer versions of dot (>1.8.10) support @@ -2640,6 +2744,8 @@ # If the GENERATE_LEGEND tag is set to YES doxygen will generate a legend page # explaining the meaning of the various boxes and arrows in the dot generated # graphs. +# Note: This tag requires that UML_LOOK isn't set, i.e. the doxygen internal +# graphical representation for inheritance and collaboration diagrams is used. # The default value is: YES. # This tag requires that the tag HAVE_DOT is set to YES. @@ -2648,8 +2754,8 @@ # If the DOT_CLEANUP tag is set to YES, doxygen will remove the intermediate # files that are used to generate the various graphs. # -# Note: This setting is not only used for dot files but also for msc and -# plantuml temporary files. +# Note: This setting is not only used for dot files but also for msc temporary +# files. # The default value is: YES. DOT_CLEANUP = YES diff --git a/hal/include/hal/gpio_api.h b/hal/include/hal/gpio_api.h index 11cd5a3..b7b6b40 100644 --- a/hal/include/hal/gpio_api.h +++ b/hal/include/hal/gpio_api.h @@ -152,7 +152,6 @@ * * @param gpio The GPIO object * @param pin The pin name (may be NC) - * @return An integer value 1 or 0 */ void gpio_init_out(gpio_t *gpio, PinName pin); diff --git a/hal/include/hal/i2c_api.h b/hal/include/hal/i2c_api.h index 48753be..91cd3a4 100644 --- a/hal/include/hal/i2c_api.h +++ b/hal/include/hal/i2c_api.h @@ -308,7 +308,6 @@ /** Configure I2C as slave or master. * @param obj The I2C object * @param enable_slave Enable i2c hardware so you can receive events with ::i2c_slave_receive - * @return non-zero if a value is available */ void i2c_slave_mode(i2c_t *obj, int enable_slave); diff --git a/platform/include/platform/internal/SysTimer.h b/platform/include/platform/internal/SysTimer.h index ac4357b..080f5b7 100644 --- a/platform/include/platform/internal/SysTimer.h +++ b/platform/include/platform/internal/SysTimer.h @@ -78,14 +78,20 @@ ~SysTimer(); public: + +#if TARGET_CORTEX_A /** * Get the interrupt number for the tick * * @return interrupt number */ -#if TARGET_CORTEX_A static IRQn_ID_t get_irq_number(); #elif TARGET_CORTEX_M + /** + * Get the interrupt number for the tick + * + * @return interrupt number + */ static IRQn_Type get_irq_number(); #endif diff --git a/platform/include/platform/mbed_atomic.h b/platform/include/platform/mbed_atomic.h index 5d015d4..e239990 100644 --- a/platform/include/platform/mbed_atomic.h +++ b/platform/include/platform/mbed_atomic.h @@ -408,8 +408,12 @@ MBED_FORCEINLINE uint8_t core_util_atomic_load_u8(const volatile uint8_t *valuePtr); /** - * \copydoc core_util_atomic_load_u8 + * Atomic load with explicit ordering. + * + * @param valuePtr Target memory location. * @param order memory ordering constraint + * + * @return The loaded value. */ MBED_FORCEINLINE uint8_t core_util_atomic_load_explicit_u8(const volatile uint8_t *valuePtr, mbed_memory_order order); @@ -452,8 +456,13 @@ /** \copydoc core_util_atomic_load_u8 */ MBED_FORCEINLINE int64_t core_util_atomic_load_s64(const volatile int64_t *valuePtr); -/** \copydoc core_util_atomic_load_u8 +/** + * Atomic load with explicit ordering. + * + * @param valuePtr Target memory location. * @param order Currently unused since 64-bit atomic ops must be emulated + * + * @return The loaded value. */ MBED_FORCEINLINE int64_t core_util_atomic_load_explicit_s64(const volatile int64_t *valuePtr, MBED_UNUSED mbed_memory_order order); @@ -477,7 +486,10 @@ MBED_FORCEINLINE void core_util_atomic_store_u8(volatile uint8_t *valuePtr, uint8_t desiredValue); /** - * \copydoc core_util_atomic_store_u8 + * Atomic store with explicit ordering. + * + * @param valuePtr Target memory location. + * @param desiredValue The value to store. * @param order memory ordering constraint */ MBED_FORCEINLINE void core_util_atomic_store_explicit_u8(volatile uint8_t *valuePtr, uint8_t desiredValue, mbed_memory_order order); diff --git a/platform/include/platform/mbed_error.h b/platform/include/platform/mbed_error.h index 899614c..032ab71 100644 --- a/platform/include/platform/mbed_error.h +++ b/platform/include/platform/mbed_error.h @@ -954,9 +954,8 @@ * Callback/Error hook function. If application implementation needs to receive this callback when an error is reported, * mbed_error_hook function should be overridden with custom implementation. When an error happens in the system error handling * implementation will invoke this callback with the mbed_error_status_t reported and the error context at the time of error. - * @param error_context Error context structure associated with this error. - * @return void * + * @param error_context Error context structure associated with this error. */ void mbed_error_hook(const mbed_error_ctx *error_context); @@ -970,8 +969,6 @@ * the callback should be aware any resource limitations/availability of resources which are yet to be initialized by application main(). * * @param error_context Error context structure associated with this error. - * @return void - * */ void mbed_error_reboot_callback(mbed_error_ctx *error_context); diff --git a/storage/kvstore/securestore/include/securestore/SecureStore.h b/storage/kvstore/securestore/include/securestore/SecureStore.h index 4eb8c0f..63a1668 100644 --- a/storage/kvstore/securestore/include/securestore/SecureStore.h +++ b/storage/kvstore/securestore/include/securestore/SecureStore.h @@ -65,15 +65,11 @@ * * @param[in] underlying_kv KVStore that will hold the data. * @param[in] rbp_kv Additional KVStore used for rollback protection. - * - * @returns none */ SecureStore(KVStore *underlying_kv, KVStore *rbp_kv = 0); /** * @brief Class destructor - * - * @returns none */ virtual ~SecureStore(); diff --git a/storage/kvstore/tdbstore/include/tdbstore/TDBStore.h b/storage/kvstore/tdbstore/include/tdbstore/TDBStore.h index 6015114..e7177c0 100644 --- a/storage/kvstore/tdbstore/include/tdbstore/TDBStore.h +++ b/storage/kvstore/tdbstore/include/tdbstore/TDBStore.h @@ -51,15 +51,11 @@ * @brief Class constructor * * @param[in] bd Underlying block device. - * - * @returns none */ TDBStore(BlockDevice *bd); /** * @brief Class destructor - * - * @returns none */ virtual ~TDBStore();