[docs] Improve readability of ROCprofiler-SDK API library documentation (#359)
* Use custom .rst to make api doc more readable. * Update index.rst * Misc docs updates - doxygen source code fixes - updated doxygen files - fixed conf.py (does not generate code in source tree) * Update source/docs/api-reference/rocprofiler-sdk_api_reference.rst Co-authored-by: Rawat, Swati <Swati.Rawat@amd.com> * Update source/docs/api-reference/rocprofiler-sdk_api_reference.rst Co-authored-by: Rawat, Swati <Swati.Rawat@amd.com> * Update source/docs/api-reference/rocprofiler-sdk_api/modules.rst Co-authored-by: Rawat, Swati <Swati.Rawat@amd.com> * Update source/docs/api-reference/rocprofiler-sdk_api/global_data_structures_topics_files.rst Co-authored-by: Rawat, Swati <Swati.Rawat@amd.com> * Duplicate * test warnings * Update CMakeLists.txt * Update rocprofiler-sdk.dox.in * Update update-docs.sh * fix docs build failures by -q -T flags. * set warn_as_error to NO. * test -W to suppress warnings. * remove -q flag from make. * reduce dot graph depth to 100 * Update custom docs target - docs target is now no longer part of the dependency list for the all target - installation of docs requires explicitly building the docs target (i.e. OPTIONAL install of _build/html/ folder) * add quit and trace mode back. * increase DOT_GRAPH_MAX_NODES to 500 back. * Format. --------- Co-authored-by: Venkateshwar Reddy Kandula <vkandula@amd.com> Co-authored-by: Jonathan R. Madsen <jonathanrmadsen@gmail.com> Co-authored-by: Bhardwaj, Gopesh <Gopesh.Bhardwaj@amd.com> Co-authored-by: Rawat, Swati <Swati.Rawat@amd.com> Co-authored-by: Madsen, Jonathan <Jonathan.Madsen@amd.com>
Этот коммит содержится в:
коммит произвёл
GitHub
родитель
6f17da7ade
Коммит
6ec9526475
@@ -5,7 +5,7 @@ if(NOT ROCPROFILER_BUILD_DOCS)
|
||||
return()
|
||||
endif()
|
||||
|
||||
set(PACKAGE_NAME ${PROJECT_NAME}-sdk)
|
||||
set(PACKAGE_NAME ${PROJECT_NAME})
|
||||
|
||||
include(FetchContent)
|
||||
|
||||
@@ -124,23 +124,23 @@ doxygen rocprofiler-sdk-roctx.dox
|
||||
doxysphinx build \${WORK_DIR} \${WORK_DIR}/_build/html \${WORK_DIR}/_doxygen/rocprofiler-sdk/html
|
||||
doxysphinx build \${WORK_DIR} \${WORK_DIR}/_build/html \${WORK_DIR}/_doxygen/roctx/html
|
||||
|
||||
make html SPHINXOPTS=\"-W --keep-going ${DOCS_BUILD_JOBS} -n\"
|
||||
make html SPHINXOPTS=\"--keep-going -n -q -T ${DOCS_BUILD_JOBS}\"
|
||||
|
||||
rm -rf ${PROJECT_SOURCE_DIR}/build-docs
|
||||
")
|
||||
|
||||
if(CHMOD_CMD)
|
||||
docs_execute_process(${CHMOD_CMD} +x ${CMAKE_CURRENT_BINARY_DIR}/build-docs.sh)
|
||||
add_custom_target(docs ALL ${CMAKE_COMMAND} -E env HOME=${DOCS_WD}
|
||||
${CMAKE_CURRENT_BINARY_DIR}/build-docs.sh)
|
||||
add_custom_target(docs ${CMAKE_COMMAND} -E env HOME=${DOCS_WD}
|
||||
${CMAKE_CURRENT_BINARY_DIR}/build-docs.sh)
|
||||
else()
|
||||
add_custom_target(docs ALL ${CMAKE_COMMAND} -E env HOME=${DOCS_WD} ${SHELL_CMD}
|
||||
${CMAKE_CURRENT_BINARY_DIR}/build-docs.sh)
|
||||
add_custom_target(docs ${CMAKE_COMMAND} -E env HOME=${DOCS_WD} ${SHELL_CMD}
|
||||
${CMAKE_CURRENT_BINARY_DIR}/build-docs.sh)
|
||||
endif()
|
||||
|
||||
install(
|
||||
DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}/_build/html/
|
||||
DESTINATION ${CMAKE_INSTALL_DATAROOTDIR}/html/${PACKAGE_NAME}
|
||||
COMPONENT docs
|
||||
USE_SOURCE_PERMISSIONS FILES_MATCHING
|
||||
OPTIONAL USE_SOURCE_PERMISSIONS FILES_MATCHING
|
||||
PATTERN "*")
|
||||
|
||||
@@ -31,8 +31,35 @@ subtrees:
|
||||
title: Counter collection services
|
||||
- file: api-reference/pc_sampling
|
||||
title: PC sampling
|
||||
- file: _doxygen/rocprofiler-sdk/html/index
|
||||
title: ROCprofiler-SDK API library
|
||||
- file: api-reference/rocprofiler-sdk_api_reference
|
||||
subtrees:
|
||||
- entries:
|
||||
- file: api-reference/rocprofiler-sdk_api/modules
|
||||
subtrees:
|
||||
- entries:
|
||||
- file: api-reference/rocprofiler-sdk_api/modules/agent_information
|
||||
- file: api-reference/rocprofiler-sdk_api/modules/buffer_handling
|
||||
- file: api-reference/rocprofiler-sdk_api/modules/buffer_tracing
|
||||
- file: api-reference/rocprofiler-sdk_api/modules/callback_tracing
|
||||
- file: api-reference/rocprofiler-sdk_api/modules/context_management
|
||||
- file: api-reference/rocprofiler-sdk_api/modules/counter_config
|
||||
- file: api-reference/rocprofiler-sdk_api/modules/counters
|
||||
- file: api-reference/rocprofiler-sdk_api/modules/device_counting_service
|
||||
- file: api-reference/rocprofiler-sdk_api/modules/dispatch_counting_service
|
||||
- file: api-reference/rocprofiler-sdk_api/modules/external_correalation
|
||||
- file: api-reference/rocprofiler-sdk_api/modules/intercept_table
|
||||
- file: api-reference/rocprofiler-sdk_api/modules/internal_threading_management
|
||||
- file: api-reference/rocprofiler-sdk_api/modules/ompt_registration
|
||||
- file: api-reference/rocprofiler-sdk_api/modules/pc_sampling_service
|
||||
- file: api-reference/rocprofiler-sdk_api/modules/thread_trace
|
||||
- file: api-reference/rocprofiler-sdk_api/modules/tool_registration
|
||||
- file: api-reference/rocprofiler-sdk_api/global_data_structures_topics_files
|
||||
subtrees:
|
||||
- entries:
|
||||
- file: api-reference/rocprofiler-sdk_api/global_data_structures_topics_files/global_basic_data_types
|
||||
- file: _doxygen/rocprofiler-sdk/html/topics
|
||||
- file: _doxygen/rocprofiler-sdk/html/annotated
|
||||
- file: _doxygen/rocprofiler-sdk/html/files
|
||||
- file: _doxygen/roctx/html/index
|
||||
title: ROCTx API library
|
||||
- caption: Conceptual
|
||||
|
||||
+15
@@ -0,0 +1,15 @@
|
||||
.. meta::
|
||||
:description: The Global Data structures, topics and files reference page.
|
||||
|
||||
.. _global_data_structures_topics_files_reference:
|
||||
|
||||
*******************************************************************************
|
||||
Global Data structures, topics, files
|
||||
*******************************************************************************
|
||||
|
||||
This ROCprofiler-SDK API topic covers:
|
||||
|
||||
* :ref:`global_basic_data_types_reference`
|
||||
* :doc:`../../_doxygen/rocprofiler-sdk/html/topics`
|
||||
* :doc:`../../_doxygen/rocprofiler-sdk/html/annotated`
|
||||
* :doc:`../../_doxygen/rocprofiler-sdk/html/files`
|
||||
+11
@@ -0,0 +1,11 @@
|
||||
.. meta::
|
||||
:description: The global basic data types reference page.
|
||||
|
||||
.. _global_basic_data_types_reference:
|
||||
|
||||
*******************************************************************************
|
||||
Global Basic Data Types
|
||||
*******************************************************************************
|
||||
|
||||
.. doxygengroup:: BASIC_DATA_TYPES
|
||||
:content-only:
|
||||
@@ -0,0 +1,28 @@
|
||||
.. meta::
|
||||
:description: The ROCprofiler-SDK API modules reference page.
|
||||
:keywords: AMD, ROCm, modules
|
||||
|
||||
.. _modules_reference:
|
||||
|
||||
*******************************************************************************
|
||||
Modules
|
||||
*******************************************************************************
|
||||
|
||||
The ROCprofiler-SDK API is organized into the following modules based on functionality:
|
||||
|
||||
* :ref:`agent_information_reference`
|
||||
* :ref:`buffer_handling_reference`
|
||||
* :ref:`buffer_tracing_reference`
|
||||
* :ref:`callback_tracing_reference`
|
||||
* :ref:`context_management_reference`
|
||||
* :ref:`counters_reference`
|
||||
* :ref:`counter_config_reference`
|
||||
* :ref:`device_counting_service_reference`
|
||||
* :ref:`dispatch_counting_service_reference`
|
||||
* :ref:`external_correlation_reference`
|
||||
* :ref:`intercept_table_reference`
|
||||
* :ref:`internal_threading_management_reference`
|
||||
* :ref:`ompt_registration_reference`
|
||||
* :ref:`pc_sampling_service_reference`
|
||||
* :ref:`thread_trace_reference`
|
||||
* :ref:`tool_registration_reference`
|
||||
@@ -0,0 +1,11 @@
|
||||
.. meta::
|
||||
:description: The Agent Information reference page.
|
||||
|
||||
.. _agent_information_reference:
|
||||
|
||||
*******************************************************************************
|
||||
Agent Information
|
||||
*******************************************************************************
|
||||
|
||||
.. doxygengroup:: AGENTS
|
||||
:content-only:
|
||||
@@ -0,0 +1,11 @@
|
||||
.. meta::
|
||||
:description: The buffer handling reference page.
|
||||
|
||||
.. _buffer_handling_reference:
|
||||
|
||||
*******************************************************************************
|
||||
Buffer handling
|
||||
*******************************************************************************
|
||||
|
||||
.. doxygengroup:: BUFFER_HANDLING
|
||||
:content-only:
|
||||
@@ -0,0 +1,11 @@
|
||||
.. meta::
|
||||
:description: The buffer tracing reference page.
|
||||
|
||||
.. _buffer_tracing_reference:
|
||||
|
||||
*******************************************************************************
|
||||
Buffer tracing
|
||||
*******************************************************************************
|
||||
|
||||
.. doxygengroup:: BUFFER_TRACING_SERVICE
|
||||
:content-only:
|
||||
@@ -0,0 +1,11 @@
|
||||
.. meta::
|
||||
:description: The callback tracing reference page.
|
||||
|
||||
.. _callback_tracing_reference:
|
||||
|
||||
*******************************************************************************
|
||||
Callback tracing
|
||||
*******************************************************************************
|
||||
|
||||
.. doxygengroup:: CALLBACK_TRACING_SERVICE
|
||||
:content-only:
|
||||
@@ -0,0 +1,11 @@
|
||||
.. meta::
|
||||
:description: The context management reference page.
|
||||
|
||||
.. _context_management_reference:
|
||||
|
||||
*******************************************************************************
|
||||
Context management
|
||||
*******************************************************************************
|
||||
|
||||
.. doxygengroup:: CONTEXT_OPERATIONS
|
||||
:content-only:
|
||||
@@ -0,0 +1,11 @@
|
||||
.. meta::
|
||||
:description: The counter config reference page.
|
||||
|
||||
.. _counter_config_reference:
|
||||
|
||||
*******************************************************************************
|
||||
Counter config
|
||||
*******************************************************************************
|
||||
|
||||
.. doxygengroup:: COUNTER_CONFIG
|
||||
:content-only:
|
||||
@@ -0,0 +1,11 @@
|
||||
.. meta::
|
||||
:description: The counters reference page.
|
||||
|
||||
.. _counters_reference:
|
||||
|
||||
*******************************************************************************
|
||||
Counters
|
||||
*******************************************************************************
|
||||
|
||||
.. doxygengroup:: COUNTERS
|
||||
:content-only:
|
||||
+11
@@ -0,0 +1,11 @@
|
||||
.. meta::
|
||||
:description: The device counting service reference page.
|
||||
|
||||
.. _device_counting_service_reference:
|
||||
|
||||
*******************************************************************************
|
||||
Device counting service
|
||||
*******************************************************************************
|
||||
|
||||
.. doxygengroup:: device_counting_service
|
||||
:content-only:
|
||||
+11
@@ -0,0 +1,11 @@
|
||||
.. meta::
|
||||
:description: The dispatch counting service reference page.
|
||||
|
||||
.. _dispatch_counting_service_reference:
|
||||
|
||||
*******************************************************************************
|
||||
Dispatch counting service
|
||||
*******************************************************************************
|
||||
|
||||
.. doxygengroup:: dispatch_counting_service
|
||||
:content-only:
|
||||
+11
@@ -0,0 +1,11 @@
|
||||
.. meta::
|
||||
:description: The external correlation reference page.
|
||||
|
||||
.. _external_correlation_reference:
|
||||
|
||||
*******************************************************************************
|
||||
External correlation
|
||||
*******************************************************************************
|
||||
|
||||
.. doxygengroup:: EXTERNAL_CORRELATION
|
||||
:content-only:
|
||||
@@ -0,0 +1,11 @@
|
||||
.. meta::
|
||||
:description: The Intercept table reference page.
|
||||
|
||||
.. _intercept_table_reference:
|
||||
|
||||
*******************************************************************************
|
||||
Intercept table
|
||||
*******************************************************************************
|
||||
|
||||
.. doxygengroup:: INTERCEPT_TABLE
|
||||
:content-only:
|
||||
+11
@@ -0,0 +1,11 @@
|
||||
.. meta::
|
||||
:description: The intenal threading management reference page.
|
||||
|
||||
.. _internal_threading_management_reference:
|
||||
|
||||
*******************************************************************************
|
||||
Internal threading management
|
||||
*******************************************************************************
|
||||
|
||||
.. doxygengroup:: INTERNAL_THREADING
|
||||
:content-only:
|
||||
@@ -0,0 +1,11 @@
|
||||
.. meta::
|
||||
:description: The OMPT Registration reference page.
|
||||
|
||||
.. _ompt_registration_reference:
|
||||
|
||||
*******************************************************************************
|
||||
OMPT Registration
|
||||
*******************************************************************************
|
||||
|
||||
.. doxygengroup:: OMPT_REGISTRATION
|
||||
:content-only:
|
||||
@@ -0,0 +1,11 @@
|
||||
.. meta::
|
||||
:description: The PC Sampling service reference page.
|
||||
|
||||
.. _pc_sampling_service_reference:
|
||||
|
||||
*******************************************************************************
|
||||
PC Sampling service
|
||||
*******************************************************************************
|
||||
|
||||
.. doxygengroup:: PC_SAMPLING_SERVICE
|
||||
:content-only:
|
||||
@@ -0,0 +1,11 @@
|
||||
.. meta::
|
||||
:description: The thread trace reference page.
|
||||
|
||||
.. _thread_trace_reference:
|
||||
|
||||
*******************************************************************************
|
||||
Thread trace
|
||||
*******************************************************************************
|
||||
|
||||
.. doxygengroup:: THREAD_TRACE
|
||||
:content-only:
|
||||
@@ -0,0 +1,11 @@
|
||||
.. meta::
|
||||
:description: The tool registration reference page.
|
||||
|
||||
.. _tool_registration_reference:
|
||||
|
||||
*******************************************************************************
|
||||
Tool registration
|
||||
*******************************************************************************
|
||||
|
||||
.. doxygengroup:: REGISTRATION_GROUP
|
||||
:content-only:
|
||||
@@ -0,0 +1,14 @@
|
||||
.. meta::
|
||||
:description: ROCprofiler-SDK API reference page
|
||||
:keywords: AMD, ROCm, HSA
|
||||
|
||||
.. _rocprofiler_sdk_api_reference:
|
||||
|
||||
********************************************************************************
|
||||
ROCprofiler-SDK API library
|
||||
********************************************************************************
|
||||
|
||||
This ROCprofiler-SDK API topic covers:
|
||||
|
||||
* :ref:`modules_reference`
|
||||
* :ref:`global_data_structures_topics_files_reference`
|
||||
@@ -41,17 +41,6 @@ def build_doxyfile():
|
||||
)
|
||||
|
||||
|
||||
def configure_version_header():
|
||||
sp.run(
|
||||
[
|
||||
"cmake",
|
||||
f"-S {_srcdir}/source/include/rocprofiler-sdk",
|
||||
f"-B {_srcdir}/source/include/rocprofiler-sdk",
|
||||
]
|
||||
)
|
||||
|
||||
|
||||
configure_version_header()
|
||||
build_doxyfile()
|
||||
|
||||
# -- Project information -----------------------------------------------------
|
||||
@@ -78,7 +67,7 @@ doxygen_root = "."
|
||||
doxysphinx_enabled = True
|
||||
doxygen_project = {
|
||||
"name": "rocprofiler-sdk",
|
||||
"path": "_doxygen",
|
||||
"path": "_doxygen/rocprofiler-sdk/xml",
|
||||
}
|
||||
doxyfile = "rocprofiler-sdk.dox"
|
||||
|
||||
|
||||
@@ -43,7 +43,7 @@ The documentation is structured as follows:
|
||||
* :doc:`Callback services <api-reference/callback_services>`
|
||||
* :doc:`Counter collection services <api-reference/counter_collection_services>`
|
||||
* :doc:`PC sampling <api-reference/pc_sampling>`
|
||||
* :doc:`ROCprofiler-SDK API library <_doxygen/rocprofiler-sdk/html/index>`
|
||||
* :doc:`ROCprofiler-SDK API <api-reference/rocprofiler-sdk_api_reference>`
|
||||
* :doc:`ROCTx API library <_doxygen/roctx/html/index>`
|
||||
|
||||
.. grid-item-card:: Conceptual
|
||||
|
||||
@@ -65,7 +65,7 @@ TIMESTAMP = NO
|
||||
#---------------------------------------------------------------------------
|
||||
# Build related configuration options
|
||||
#---------------------------------------------------------------------------
|
||||
EXTRACT_ALL = YES
|
||||
EXTRACT_ALL = NO
|
||||
EXTRACT_PRIVATE = NO
|
||||
EXTRACT_PRIV_VIRTUAL = NO
|
||||
EXTRACT_PACKAGE = NO
|
||||
@@ -73,9 +73,9 @@ EXTRACT_STATIC = NO
|
||||
EXTRACT_LOCAL_CLASSES = YES
|
||||
EXTRACT_LOCAL_METHODS = NO
|
||||
EXTRACT_ANON_NSPACES = NO
|
||||
RESOLVE_UNNAMED_PARAMS = YES
|
||||
RESOLVE_UNNAMED_PARAMS = NO
|
||||
HIDE_UNDOC_MEMBERS = NO
|
||||
HIDE_UNDOC_CLASSES = YES
|
||||
HIDE_UNDOC_CLASSES = NO
|
||||
HIDE_FRIEND_COMPOUNDS = NO
|
||||
HIDE_IN_BODY_DOCS = NO
|
||||
INTERNAL_DOCS = NO
|
||||
@@ -84,8 +84,8 @@ HIDE_SCOPE_NAMES = NO
|
||||
HIDE_COMPOUND_REFERENCE= NO
|
||||
SHOW_HEADERFILE = YES
|
||||
SHOW_INCLUDE_FILES = YES
|
||||
SHOW_GROUPED_MEMB_INC = NO
|
||||
FORCE_LOCAL_INCLUDES = YES
|
||||
SHOW_GROUPED_MEMB_INC = YES
|
||||
FORCE_LOCAL_INCLUDES = NO
|
||||
INLINE_INFO = YES
|
||||
SORT_MEMBER_DOCS = YES
|
||||
SORT_BRIEF_DOCS = NO
|
||||
@@ -110,12 +110,12 @@ CITE_BIB_FILES =
|
||||
#---------------------------------------------------------------------------
|
||||
QUIET = YES
|
||||
WARNINGS = YES
|
||||
WARN_IF_UNDOCUMENTED = YES
|
||||
WARN_IF_UNDOCUMENTED = NO
|
||||
WARN_IF_DOC_ERROR = YES
|
||||
WARN_IF_INCOMPLETE_DOC = YES
|
||||
WARN_NO_PARAMDOC = YES
|
||||
WARN_IF_UNDOC_ENUM_VAL = NO
|
||||
WARN_AS_ERROR = NO
|
||||
WARN_AS_ERROR = YES
|
||||
WARN_FORMAT = "---> WARNING! $file:$line: $text"
|
||||
WARN_LINE_FORMAT = "at line $line of file $file"
|
||||
WARN_LOGFILE =
|
||||
@@ -148,21 +148,22 @@ EXCLUDE_PATTERNS = */.git/* \
|
||||
@SOURCE_DIR@/**/cmake/* \
|
||||
@SOURCE_DIR@/**/external/* \
|
||||
@SOURCE_DIR@/**/RPM/* \
|
||||
@SOURCE_DIR@/**/ISSUE_TEMPLATE/*
|
||||
|
||||
@SOURCE_DIR@/**/ISSUE_TEMPLATE/* \
|
||||
@SOURCE_DIR@/**/rocprofiler-sdk/**/* \
|
||||
@SOURCE_DIR@/**/rocprofiler-sdk-roctx/api_trace.h
|
||||
EXCLUDE_SYMBOLS = "std::*" \
|
||||
"ROCPROFILER_ATTRIBUTE" \
|
||||
"ROCPROFILER_API" \
|
||||
"ROCPROFILER_NONNULL" \
|
||||
"ROCPROFILER_PUBLIC_API" \
|
||||
"ROCPROFILER_HIDDEN_API" \
|
||||
"ROCPROFILER_EXPORT_DECORATOR" \
|
||||
"ROCPROFILER_IMPORT_DECORATOR" \
|
||||
"ROCPROFILER_EXPORT" \
|
||||
"ROCPROFILER_IMPORT" \
|
||||
"ROCPROFILER_HANDLE_LITERAL" \
|
||||
"ROCPROFILER_EXTERN_C_INIT" \
|
||||
"ROCPROFILER_EXTERN_C_FINI"
|
||||
"ROCTX_ATTRIBUTE" \
|
||||
"ROCTX_API" \
|
||||
"ROCTX_NONNULL" \
|
||||
"ROCTX_PUBLIC_API" \
|
||||
"ROCTX_HIDDEN_API" \
|
||||
"ROCTX_EXPORT_DECORATOR" \
|
||||
"ROCTX_IMPORT_DECORATOR" \
|
||||
"ROCTX_EXPORT" \
|
||||
"ROCTX_IMPORT" \
|
||||
"ROCTX_HANDLE_LITERAL" \
|
||||
"ROCTX_EXTERN_C_INIT" \
|
||||
"ROCTX_EXTERN_C_FINI"
|
||||
EXAMPLE_PATH = @SOURCE_DIR@/samples
|
||||
EXAMPLE_PATTERNS = *.h \
|
||||
*.hh \
|
||||
@@ -177,7 +178,7 @@ INPUT_FILTER =
|
||||
FILTER_PATTERNS =
|
||||
FILTER_SOURCE_FILES = NO
|
||||
FILTER_SOURCE_PATTERNS =
|
||||
USE_MDFILE_AS_MAINPAGE =
|
||||
USE_MDFILE_AS_MAINPAGE =
|
||||
FORTRAN_COMMENT_AFTER = 72
|
||||
#---------------------------------------------------------------------------
|
||||
# Configuration options related to source browsing
|
||||
@@ -202,10 +203,10 @@ IGNORE_PREFIX =
|
||||
GENERATE_HTML = YES
|
||||
HTML_OUTPUT = html
|
||||
HTML_FILE_EXTENSION = .html
|
||||
HTML_HEADER =
|
||||
HTML_FOOTER =
|
||||
HTML_STYLESHEET =
|
||||
HTML_EXTRA_STYLESHEET =
|
||||
HTML_HEADER =
|
||||
HTML_FOOTER =
|
||||
HTML_STYLESHEET =
|
||||
HTML_EXTRA_STYLESHEET =
|
||||
HTML_EXTRA_FILES =
|
||||
HTML_COLORSTYLE = LIGHT
|
||||
HTML_COLORSTYLE_HUE = 220
|
||||
@@ -339,17 +340,17 @@ SEARCH_INCLUDES = NO
|
||||
INCLUDE_PATH = @SOURCE_DIR@/source/include
|
||||
INCLUDE_FILE_PATTERNS = *.h \
|
||||
*.hpp
|
||||
PREDEFINED = "ROCPROFILER_API=" \
|
||||
"ROCPROFILER_EXPORT=" \
|
||||
"ROCPROFILER_IMPORT=" \
|
||||
"ROCPROFILER_NONNULL(...)=" \
|
||||
"ROCPROFILER_PUBLIC_API=" \
|
||||
"ROCPROFILER_HIDDEN_API=" \
|
||||
"ROCPROFILER_EXPORT_DECORATOR=" \
|
||||
"ROCPROFILER_IMPORT_DECORATOR=" \
|
||||
"ROCPROFILER_HANDLE_LITERAL=" \
|
||||
"ROCPROFILER_EXTERN_C_INIT=" \
|
||||
"ROCPROFILER_EXTERN_C_FINI=" \
|
||||
PREDEFINED = "ROCTX_API=" \
|
||||
"ROCTX_EXPORT=" \
|
||||
"ROCTX_IMPORT=" \
|
||||
"ROCTX_NONNULL(...)=" \
|
||||
"ROCTX_PUBLIC_API=" \
|
||||
"ROCTX_HIDDEN_API=" \
|
||||
"ROCTX_EXPORT_DECORATOR=" \
|
||||
"ROCTX_IMPORT_DECORATOR=" \
|
||||
"ROCTX_HANDLE_LITERAL=" \
|
||||
"ROCTX_EXTERN_C_INIT=" \
|
||||
"ROCTX_EXTERN_C_FINI=" \
|
||||
"__attribute__(x)=" \
|
||||
"__declspec(x)=" \
|
||||
"size_t=unsigned long" \
|
||||
|
||||
@@ -65,7 +65,7 @@ TIMESTAMP = NO
|
||||
#---------------------------------------------------------------------------
|
||||
# Build related configuration options
|
||||
#---------------------------------------------------------------------------
|
||||
EXTRACT_ALL = YES
|
||||
EXTRACT_ALL = NO
|
||||
EXTRACT_PRIVATE = NO
|
||||
EXTRACT_PRIV_VIRTUAL = NO
|
||||
EXTRACT_PACKAGE = NO
|
||||
@@ -73,7 +73,7 @@ EXTRACT_STATIC = NO
|
||||
EXTRACT_LOCAL_CLASSES = YES
|
||||
EXTRACT_LOCAL_METHODS = NO
|
||||
EXTRACT_ANON_NSPACES = NO
|
||||
RESOLVE_UNNAMED_PARAMS = YES
|
||||
RESOLVE_UNNAMED_PARAMS = NO
|
||||
HIDE_UNDOC_MEMBERS = NO
|
||||
HIDE_UNDOC_CLASSES = YES
|
||||
HIDE_FRIEND_COMPOUNDS = NO
|
||||
@@ -84,8 +84,8 @@ HIDE_SCOPE_NAMES = NO
|
||||
HIDE_COMPOUND_REFERENCE= NO
|
||||
SHOW_HEADERFILE = YES
|
||||
SHOW_INCLUDE_FILES = YES
|
||||
SHOW_GROUPED_MEMB_INC = NO
|
||||
FORCE_LOCAL_INCLUDES = YES
|
||||
SHOW_GROUPED_MEMB_INC = YES
|
||||
FORCE_LOCAL_INCLUDES = NO
|
||||
INLINE_INFO = YES
|
||||
SORT_MEMBER_DOCS = YES
|
||||
SORT_BRIEF_DOCS = NO
|
||||
@@ -110,7 +110,7 @@ CITE_BIB_FILES =
|
||||
#---------------------------------------------------------------------------
|
||||
QUIET = YES
|
||||
WARNINGS = YES
|
||||
WARN_IF_UNDOCUMENTED = YES
|
||||
WARN_IF_UNDOCUMENTED = NO
|
||||
WARN_IF_DOC_ERROR = YES
|
||||
WARN_IF_INCOMPLETE_DOC = YES
|
||||
WARN_NO_PARAMDOC = YES
|
||||
@@ -140,8 +140,7 @@ FILE_PATTERNS = *.h \
|
||||
*.tcc \
|
||||
conf.py
|
||||
RECURSIVE = YES
|
||||
EXCLUDE = @SOURCE_DIR@/README.md \
|
||||
@SOURCE_DIR@/include/rocprofiler-sdk/rccl/details/rccl.h
|
||||
EXCLUDE = @SOURCE_DIR@/README.md
|
||||
EXCLUDE_SYMLINKS = YES
|
||||
EXCLUDE_PATTERNS = */.git/* \
|
||||
@SOURCE_DIR@/**/tests/* \
|
||||
@@ -150,7 +149,11 @@ EXCLUDE_PATTERNS = */.git/* \
|
||||
@SOURCE_DIR@/**/cmake/* \
|
||||
@SOURCE_DIR@/**/external/* \
|
||||
@SOURCE_DIR@/**/RPM/* \
|
||||
@SOURCE_DIR@/**/ISSUE_TEMPLATE/*
|
||||
@SOURCE_DIR@/**/ISSUE_TEMPLATE/* \
|
||||
@SOURCE_DIR@/**/rocprofiler-sdk/ompt/omp-tools.h \
|
||||
@SOURCE_DIR@/**/rocprofiler-sdk/rccl/details/* \
|
||||
@SOURCE_DIR@/**/rocprofiler-sdk/rocdecode/details/* \
|
||||
@SOURCE_DIR@/**/rocprofiler-sdk/rocjpeg/details/*
|
||||
EXCLUDE_SYMBOLS = "std::*" \
|
||||
"ROCPROFILER_ATTRIBUTE" \
|
||||
"ROCPROFILER_API" \
|
||||
@@ -163,7 +166,10 @@ EXCLUDE_SYMBOLS = "std::*" \
|
||||
"ROCPROFILER_IMPORT" \
|
||||
"ROCPROFILER_HANDLE_LITERAL" \
|
||||
"ROCPROFILER_EXTERN_C_INIT" \
|
||||
"ROCPROFILER_EXTERN_C_FINI"
|
||||
"ROCPROFILER_EXTERN_C_FINI" \
|
||||
"ROCPROFILER_SDK_DEPRECATED_WARNINGS" \
|
||||
"ROCPROFILER_SDK_EXPERIMENTAL_WARNINGS" \
|
||||
"ROCPROFILER_*_LAST"
|
||||
EXAMPLE_PATH = @SOURCE_DIR@/samples
|
||||
EXAMPLE_PATTERNS = *.h \
|
||||
*.hh \
|
||||
@@ -351,6 +357,8 @@ PREDEFINED = "ROCPROFILER_API=" \
|
||||
"ROCPROFILER_HANDLE_LITERAL=" \
|
||||
"ROCPROFILER_EXTERN_C_INIT=" \
|
||||
"ROCPROFILER_EXTERN_C_FINI=" \
|
||||
"ROCPROFILER_SDK_DEPRECATED(...)=" \
|
||||
"ROCPROFILER_SDK_EXPERIMENTAL=" \
|
||||
"__attribute__(x)=" \
|
||||
"__declspec(x)=" \
|
||||
"size_t=unsigned long" \
|
||||
@@ -400,7 +408,7 @@ DIAFILE_DIRS =
|
||||
PLANTUML_JAR_PATH =
|
||||
PLANTUML_CFG_FILE =
|
||||
PLANTUML_INCLUDE_PATH =
|
||||
DOT_GRAPH_MAX_NODES = 100
|
||||
DOT_GRAPH_MAX_NODES = 500
|
||||
MAX_DOT_GRAPH_DEPTH = 0
|
||||
DOT_MULTI_TARGETS = YES
|
||||
GENERATE_LEGEND = YES
|
||||
|
||||
Ссылка в новой задаче
Block a user