derek.holloway
7502bf64a4
CodeQL / Analyze (actions) (push) Canceled after 0s
CodeQL / Analyze (python) (push) Canceled after 0s
pre-commit / pre-commit (push) Canceled after 0s
Multi-Arch CI / setup (push) Canceled after 0s
Publish build_manylinux_x86_64 images / publish_build_manylinux_x86_64 (push) Canceled after 0s
Setup (Multi-Arch) / setup (push) Canceled after 0s
Multi-Arch CI / Linux::${{ fromJSON(needs.setup.outputs.linux_build_config || '{}').build_variant_label || 'skip' }} (push) Canceled after 0s
Publish TheRock Docker image / build-and-push-image (push) Canceled after 0s
Publish no_rocm_image_ubi10 image / publish_no_rocm_image_ubi10 (push) Canceled after 0s
Multi-Arch CI / Windows::${{ fromJSON(needs.setup.outputs.windows_build_config || '{}').build_variant_label || 'skip' }} (push) Canceled after 0s
Publish TheRock Docker image / build-and-push-image (push) Canceled after 0s
Multi-Arch CI / Manifest Diff (push) Canceled after 0s
TheRock Manifest Diff Report / Generate Manifest Diff Report (push) Canceled after 0s
Multi-Arch CI / CI Summary (push) Canceled after 0s
Publish no_rocm_image_ubuntu24_04 images / publish_no_rocm_image_ubuntu24_04 (push) Canceled after 0s
Publish no_rocm_image_ubuntu24_04_ocl_rt images / publish_no_rocm_image_ubuntu24_04_ocl_rt (push) Canceled after 0s
Publish TheRock Docker image / build-and-push-image (push) Canceled after 0s
Publish TheRock Docker image / build-and-push-image (push) Canceled after 0s
Publish no_rocm_image_ubuntu24_04 images / publish_no_rocm_image_ubuntu24_04_rocgdb (push) Canceled after 0s
Publish no_rocm_image_ubuntu24_04_rocgdb images / publish_no_rocm_image_ubuntu24_04_rocgdb (push) Canceled after 0s
Publish no_rocm_image_ubuntu24_04 images / publish_no_rocm_image_ubuntu24_04_ocl_rt (push) Canceled after 0s
Publish TheRock Docker image / build-and-push-image (push) Canceled after 0s
Unit Tests / Unit Tests :: ubuntu-24.04 (push) Canceled after 0s
Unit Tests / Unit Tests :: windows-2022 (push) Canceled after 0s
Publish no_rocm_image_ubuntu24_04 images / publish_no_rocm_image_ubuntu24_04_media (push) Canceled after 0s
Unit Tests / Unit Tests Summary (push) Canceled after 0s
Publish no_rocm_image_ubuntu24_04 images / publish_no_rocm_image_ubuntu24_04_openmpi (push) Canceled after 0s
83 lines
2.1 KiB
ReStructuredText
83 lines
2.1 KiB
ReStructuredText
.. title:: clang-tidy - modernize-use-nodiscard
|
|
|
|
modernize-use-nodiscard
|
|
=======================
|
|
|
|
Adds ``[[nodiscard]]`` attributes (introduced in C++17) to member functions in
|
|
order to highlight at compile time which return values should not be ignored.
|
|
|
|
Member functions need to satisfy the following conditions to be considered by
|
|
this check:
|
|
|
|
- no ``[[nodiscard]]``, ``[[noreturn]]``,
|
|
``__attribute__((warn_unused_result))``,
|
|
``[[clang::warn_unused_result]]`` nor ``[[gcc::warn_unused_result]]``
|
|
attribute,
|
|
- non-void return type,
|
|
- non-template return types,
|
|
- const member function,
|
|
- non-variadic functions,
|
|
- no non-const reference parameters,
|
|
- no pointer parameters,
|
|
- no template parameters,
|
|
- no template function parameters,
|
|
- not be a member of a class with mutable member variables,
|
|
- no Lambdas,
|
|
- no conversion functions.
|
|
|
|
Such functions have no means of altering any state or passing values other than
|
|
via the return type. Unless the member functions are altering state via some
|
|
external call (e.g. I/O).
|
|
|
|
Example
|
|
-------
|
|
|
|
.. code-block:: c++
|
|
|
|
bool empty() const;
|
|
bool empty(int i) const;
|
|
|
|
transforms to:
|
|
|
|
.. code-block:: c++
|
|
|
|
[[nodiscard]] bool empty() const;
|
|
[[nodiscard]] bool empty(int i) const;
|
|
|
|
Options
|
|
-------
|
|
|
|
.. option:: ReplacementString
|
|
|
|
Specifies a macro to use instead of ``[[nodiscard]]``. This is useful when
|
|
maintaining source code that needs to compile with a pre-C++17 compiler.
|
|
|
|
Example
|
|
^^^^^^^
|
|
|
|
.. code-block:: c++
|
|
|
|
bool empty() const;
|
|
bool empty(int i) const;
|
|
|
|
transforms to:
|
|
|
|
.. code-block:: c++
|
|
|
|
NO_DISCARD bool empty() const;
|
|
NO_DISCARD bool empty(int i) const;
|
|
|
|
if the :option:`ReplacementString` option is set to `NO_DISCARD`.
|
|
|
|
.. note::
|
|
|
|
If the :option:`ReplacementString` is not a C++ attribute, but instead a
|
|
macro, then that macro must be defined in scope or the fix-it will not be
|
|
applied.
|
|
|
|
.. note::
|
|
|
|
For alternative ``__attribute__`` syntax options to mark functions as
|
|
``[[nodiscard]]`` in non-c++17 source code.
|
|
See https://clang.llvm.org/docs/AttributeReference.html#nodiscard-warn-unused-result
|