mirror of
https://git.kernel.org/pub/scm/libs/libgpiod/libgpiod.git
synced 2026-10-24 00:48:53 +03:00
dda57bd63f
We now have comprehensive documentation available online on readthedocs. Let's not duplicate docs in README - move all information into the sphinx files. While at it: make the remaining README use markdown. Reviewed-by: Vincent Fazio <vfazio@xes-inc.com> Link: https://lore.kernel.org/r/20250211-improve-docs-v4-17-dc56702c2ca8@linaro.org Signed-off-by: Bartosz Golaszewski <bartosz.golaszewski@linaro.org>
38 lines
900 B
ReStructuredText
38 lines
900 B
ReStructuredText
..
|
|
SPDX-License-Identifier: CC-BY-SA-4.0
|
|
SPDX-FileCopyrightText: 2024-2025 Bartosz Golaszewski <bartosz.golaszewski@linaro.org>
|
|
|
|
..
|
|
This file is part of libgpiod.
|
|
|
|
libgpiodcxx API documentation
|
|
|
|
libgpiod C++ bindings API
|
|
=========================
|
|
|
|
The **C++ bindings** for **libgpiod** provide a modern C++ wrapper around the
|
|
core C API. These bindings make it easier to work with GPIO lines in C++ by
|
|
offering an **object-oriented** approach and **RAII** (Resource Acquisition
|
|
Is Initialization) principles for managing resources.
|
|
|
|
.. note::
|
|
C++17 compiler support is required to build the bindings.
|
|
|
|
.. toctree::
|
|
:maxdepth: 1
|
|
:caption: Contents
|
|
|
|
cpp_chip
|
|
cpp_chip_info
|
|
cpp_edge_event
|
|
cpp_edge_event_buffer
|
|
cpp_exceptions
|
|
cpp_info_event
|
|
cpp_line
|
|
cpp_line_info
|
|
cpp_line_config
|
|
cpp_line_settings
|
|
cpp_request_config
|
|
cpp_line_request
|
|
cpp_misc
|