From c3126d0a37f3554a6266173171f1abd430c36947 Mon Sep 17 00:00:00 2001 From: Daniel Arndt Date: Mon, 1 May 2023 15:04:09 -0400 Subject: [PATCH] Add documentation for Kokkos::printf --- docs/source/API/core/Utilities.rst | 1 + docs/source/API/core/printf.rst | 16 ++++++++++++++++ 2 files changed, 17 insertions(+) create mode 100644 docs/source/API/core/printf.rst diff --git a/docs/source/API/core/Utilities.rst b/docs/source/API/core/Utilities.rst index f26e4facd..9ca55cbd7 100644 --- a/docs/source/API/core/Utilities.rst +++ b/docs/source/API/core/Utilities.rst @@ -7,6 +7,7 @@ Utilities ./utilities/abort ./utilities/all ./utilities/complex + ./utilities/printf ./utilities/timer ./utilities/device_id ./utilities/num_threads diff --git a/docs/source/API/core/printf.rst b/docs/source/API/core/printf.rst new file mode 100644 index 000000000..00d81e0d2 --- /dev/null +++ b/docs/source/API/core/printf.rst @@ -0,0 +1,16 @@ +``Kokkos::printf`` +================= + +.. role:: cppkokkos(code) + :language: cppkokkos + +Defined in header ```` + +.. code-block:: cpp + + template + KOKKOS_FUNCTION void printf(const char* format, Args... args); + +Prints the data specified in ``format`` and ``args...`` to ``stdout``. +The behavior is analogous to ``std::printf``, but the return type is ``void`` +to ensure a consistent behavior across backends.