Commit a258ab32 authored by Gerard Marull-Paretas's avatar Gerard Marull-Paretas Committed by Dan Kalowsky
Browse files

doc: doxygen: remove rst utilities 



We no longer render Doxygen content in Sphinx after the removal of
breathe, so let's remove rst related aliases from Doxyfile. Also adjust
some headers that contained rst content.

Signed-off-by: default avatarGerard Marull-Paretas <gerard@teslabs.com>
parent a673316b

doc/zephyr.doxyfile.in

+8 −10
Original line number Diff line number Diff line
@@ -279,9 +279,7 @@ TAB_SIZE = 8 
# with the commands \{ and \} for these it is advised to use the version @{ and

# @} or use a double escape (\\{ and \\})



ALIASES                = "rst=\verbatim embed:rst:leading-asterisk" \

                         endrst=\endverbatim \

                         "kconfig{1}=\htmlonly <code>\1</code> \endhtmlonly \xmlonly <verbatim>embed:rst:inline :kconfig:option:`\1`</verbatim> \endxmlonly" \

ALIASES                = "kconfig{1}=\verbatim \1 \endverbatim" \

                         "req{1}=\ref ZEPH_\1 \"ZEPH-\1\"" \

                         "satisfy{1}=\xrefitem satisfy \"Satisfies requirement\" \"Requirement Implementation\" \1" \

                         "verify{1}=\xrefitem verify \"Verifies requirement\" \"Requirement Verification\" \1" \
@@ -289,14 +287,14 @@ ALIASES = "rst=\verbatim embed:rst:leading-asterisk" \ 
                         "kconfig_dep{2}=\attention Available only when the following Kconfig options are enabled: \kconfig{\1}, \kconfig{\2}." \

                         "kconfig_dep{3}=\attention Available only when the following Kconfig options are enabled: \kconfig{\1}, \kconfig{\2}, \kconfig{\3}." \

                         "funcprops=\par \"Function properties (list may not be complete)\"" \

                         "reschedule=\htmlonly reschedule \endhtmlonly \xmlonly <verbatim>embed:rst:inline :ref:`api_term_reschedule`</verbatim> \endxmlonly" \

                         "sleep=\htmlonly sleep \endhtmlonly \xmlonly <verbatim>embed:rst:inline :ref:`api_term_sleep`</verbatim> \endxmlonly" \

                         "no_wait=\htmlonly no-wait \endhtmlonly \xmlonly <verbatim>embed:rst:inline :ref:`api_term_no-wait`</verbatim> \endxmlonly" \

                         "isr_ok=\htmlonly isr-ok \endhtmlonly \xmlonly <verbatim>embed:rst:inline :ref:`api_term_isr-ok`</verbatim> \endxmlonly" \

                         "pre_kernel_ok=\htmlonly pre-kernel-ok \endhtmlonly \xmlonly <verbatim>embed:rst:inline :ref:`api_term_pre-kernel-ok`</verbatim> \endxmlonly" \

                         "async=\htmlonly async \endhtmlonly \xmlonly <verbatim>embed:rst:inline :ref:`api_term_async`</verbatim> \endxmlonly" \

                         "reschedule=\qualifier reschedule" \

                         "sleep=\qualifier sleep" \

                         "no_wait=\qualifier no-wait" \

                         "isr_ok=\qualifier isr-ok" \

                         "pre_kernel_ok=\qualifier pre-kernel-ok" \

                         "async=\qualifier async" \

                         "atomic_api=As for all atomic APIs, includes a full/sequentially-consistent memory barrier (where applicable)." \

                         "supervisor=\htmlonly supervisor \endhtmlonly \xmlonly <verbatim>embed:rst:inline :ref:`api_term_supervisor`</verbatim> \endxmlonly"

                         "supervisor=\qualifier supervisor"



# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources

# only. Doxygen will then generate output that is more tailored for C. For

include/zephyr/net/socket.h

+114 −170

File changed.

Preview size limit exceeded, changes collapsed.

include/zephyr/net/socket_select.h

+21 −31
Original line number Diff line number Diff line
@@ -36,17 +36,15 @@ typedef struct zvfs_fd_set zsock_fd_set; 
 * @brief Legacy function to poll multiple sockets for events

 *

 * @details

 * @rst

 * See `POSIX.1-2017 article

 * <http://pubs.opengroup.org/onlinepubs/9699919799/functions/select.html>`__

 * See POSIX.1-2017 article

 * http://pubs.opengroup.org/onlinepubs/9699919799/functions/select.html

 * for normative description. This function is provided to ease porting of

 * existing code and not recommended for usage due to its inefficiency,

 * use zsock_poll() instead. In Zephyr this function works only with

 * sockets, not arbitrary file descriptors.

 * This function is also exposed as ``select()``

 * if :kconfig:option:`CONFIG_POSIX_API` is defined (in which case

 * it may conflict with generic POSIX ``select()`` function).

 * @endrst

 * This function is also exposed as `select()`

 * if @kconfig{CONFIG_POSIX_API} is defined (in which case

 * it may conflict with generic POSIX `select()` function).

 */

static inline int zsock_select(int nfds, zsock_fd_set *readfds, zsock_fd_set *writefds,

			       zsock_fd_set *exceptfds, struct zsock_timeval *timeout)
@@ -66,13 +64,11 @@ static inline int zsock_select(int nfds, zsock_fd_set *readfds, zsock_fd_set *wr 
 * @brief Initialize (clear) fd_set

 *

 * @details

 * @rst

 * See `POSIX.1-2017 article

 * <http://pubs.opengroup.org/onlinepubs/9699919799/functions/select.html>`__

 * See POSIX.1-2017 article

 * http://pubs.opengroup.org/onlinepubs/9699919799/functions/select.html

 * for normative description.

 * This function is also exposed as ``FD_ZERO()``

 * if :kconfig:option:`CONFIG_POSIX_API` is defined.

 * @endrst

 * This function is also exposed as `FD_ZERO()`

 * if @kconfig{CONFIG_POSIX_API} is defined.

 */

static inline void ZSOCK_FD_ZERO(zsock_fd_set *set)

{
@@ -83,13 +79,11 @@ static inline void ZSOCK_FD_ZERO(zsock_fd_set *set) 
 * @brief Check whether socket is a member of fd_set

 *

 * @details

 * @rst

 * See `POSIX.1-2017 article

 * <http://pubs.opengroup.org/onlinepubs/9699919799/functions/select.html>`__

 * See POSIX.1-2017 article

 * http://pubs.opengroup.org/onlinepubs/9699919799/functions/select.html

 * for normative description.

 * This function is also exposed as ``FD_ISSET()``

 * if :kconfig:option:`CONFIG_POSIX_API` is defined.

 * @endrst

 * This function is also exposed as `FD_ISSET()`

 * if @kconfig{CONFIG_POSIX_API} is defined.

 */

static inline int ZSOCK_FD_ISSET(int fd, zsock_fd_set *set)

{
@@ -100,13 +94,11 @@ static inline int ZSOCK_FD_ISSET(int fd, zsock_fd_set *set) 
 * @brief Remove socket from fd_set

 *

 * @details

 * @rst

 * See `POSIX.1-2017 article

 * <http://pubs.opengroup.org/onlinepubs/9699919799/functions/select.html>`__

 * See POSIX.1-2017 article

 * http://pubs.opengroup.org/onlinepubs/9699919799/functions/select.html

 * for normative description.

 * This function is also exposed as ``FD_CLR()``

 * if :kconfig:option:`CONFIG_POSIX_API` is defined.

 * @endrst

 * This function is also exposed as `FD_CLR()`

 * if @kconfig{CONFIG_POSIX_API} is defined.

 */

static inline void ZSOCK_FD_CLR(int fd, zsock_fd_set *set)

{
@@ -117,13 +109,11 @@ static inline void ZSOCK_FD_CLR(int fd, zsock_fd_set *set) 
 * @brief Add socket to fd_set

 *

 * @details

 * @rst

 * See `POSIX.1-2017 article

 * <http://pubs.opengroup.org/onlinepubs/9699919799/functions/select.html>`__

 * See POSIX.1-2017 article

 * http://pubs.opengroup.org/onlinepubs/9699919799/functions/select.html

 * for normative description.

 * This function is also exposed as ``FD_SET()``

 * if :kconfig:option:`CONFIG_POSIX_API` is defined.

 * @endrst

 * This function is also exposed as `FD_SET()`

 * if @kconfig{CONFIG_POSIX_API} is defined.

 */

static inline void ZSOCK_FD_SET(int fd, zsock_fd_set *set)

{

CRA Git | Maintained and supported by SUSTech CRA and CCSE