Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Minor docs changes #260

Merged
merged 1 commit into from
Oct 4, 2023
Merged

Minor docs changes #260

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 14 additions & 13 deletions docs/internal-api.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,11 @@
Internal API
============

Data Types
^^^^^^^^^^
Internal Types
^^^^^^^^^^^^^^

Below is a list of data types used internally by libnomp.
Below is a list of internal types (structures and enums) used internally by
libnomp.

.. doxygengroup:: nomp_internal_types
:project: libnomp
Expand All @@ -22,8 +23,14 @@ Helper Macros
:project: libnomp
:content-only:

Backend Init Functions
^^^^^^^^^^^^^^^^^^^^^^
Memory Management Functions and Macros
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. doxygengroup:: nomp_mem_utils
:project: libnomp
:content-only:

Backend Initialization Functions
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. doxygengroup:: nomp_backend_init
:project: libnomp
:content-only:
Expand All @@ -34,12 +41,6 @@ Python Helper Functions
:project: libnomp
:content-only:

Memory Management Functions and Macros
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. doxygengroup:: nomp_mem_utils
:project: libnomp
:content-only:

Reductions and Related Functions
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. doxygengroup:: nomp_reduction_utils
Expand All @@ -52,8 +53,8 @@ Logging Functions
:project: libnomp
:content-only:

Profiler Functions
^^^^^^^^^^^^^^^^^^
Profiling Functions
^^^^^^^^^^^^^^^^^^^
.. doxygengroup:: nomp_profiler_utils
:project: libnomp
:content-only:
Expand Down
2 changes: 1 addition & 1 deletion include/nomp-aux.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ extern "C" {
/**
* @defgroup nomp_other_utils Other helper functions.
*
* @brief Various helper functions used for implementing the library.
* @brief Various helper functions used internally by libnomp core library.
*/

char *nomp_str_cat(unsigned n, unsigned max_len, ...);
Expand Down
9 changes: 2 additions & 7 deletions include/nomp-log.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,16 +12,11 @@ extern const char *ERR_STR_USER_DEVICE_IS_INVALID;
extern "C" {
#endif

/**
* @defgroup nomp_internal_types Internal types
*
* @brief Data types used internally by the library.
*/

/**
* @ingroup nomp_internal_types
*
* @brief Defines nomp log types. It can be an error, warning or information.
* @brief Defines nomp log levels. A log can be an error, warning or general
* information.
*/
typedef enum {
NOMP_ERROR = 1, /**< Error type. */
Expand Down