diff options
| author | Daniel Scally <dan.scally@ideasonboard.com> | 2024-08-08 15:09:44 +0100 |
|---|---|---|
| committer | Laurent Pinchart <laurent.pinchart@ideasonboard.com> | 2024-08-14 03:57:47 +0300 |
| commit | f57e9fa6dde5999bab71fc9a756bc5e1e6e68739 (patch) | |
| tree | 1694f62d862671e6618255f6b45ba6266fff7854 /Documentation/Doxyfile.in | |
| parent | 15a51caae8811817f55af0a925915d8fa45ca7a4 (diff) | |
Documentation: Add Thread safety page
Move the section of the Thread support page dealing with thread safety
to a dedicated .dox file at Documentation/. This is done to support the
splitting of the Documentation into a public and internal version. With
a separate page, references can be made to thread safety without having
to include the Thread class in the doxygen run. Some sections of the new
page are still specific to internal implementations and so are hidden
with the \internal flag and an internal section which is conditionally
included. For now, hardcode it to be included in the Doxyfile.
Signed-off-by: Daniel Scally <dan.scally@ideasonboard.com>
Reviewed-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
Signed-off-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
Diffstat (limited to 'Documentation/Doxyfile.in')
| -rw-r--r-- | Documentation/Doxyfile.in | 5 |
1 files changed, 4 insertions, 1 deletions
diff --git a/Documentation/Doxyfile.in b/Documentation/Doxyfile.in index 62e63968..203f8e67 100644 --- a/Documentation/Doxyfile.in +++ b/Documentation/Doxyfile.in @@ -17,13 +17,15 @@ EXTENSION_MAPPING = h=C++ TOC_INCLUDE_HEADINGS = 0 +ENABLED_SECTIONS = internal INTERNAL_DOCS = YES CASE_SENSE_NAMES = YES QUIET = YES WARN_AS_ERROR = @WARN_AS_ERROR@ -INPUT = "@TOP_SRCDIR@/include/libcamera" \ +INPUT = "@TOP_SRCDIR@/Documentation" \ + "@TOP_SRCDIR@/include/libcamera" \ "@TOP_SRCDIR@/src/ipa/ipu3" \ "@TOP_SRCDIR@/src/ipa/libipa" \ "@TOP_SRCDIR@/src/libcamera" \ @@ -32,6 +34,7 @@ INPUT = "@TOP_SRCDIR@/include/libcamera" \ FILE_PATTERNS = *.c \ *.cpp \ + *.dox \ *.h RECURSIVE = YES |