aboutsummaryrefslogtreecommitdiff
path: root/include/armnn/IRuntime.hpp
diff options
context:
space:
mode:
authorRyan OShea <Ryan.OShea2@arm.com>2020-02-12 16:15:27 +0000
committerJim Flynn <jim.flynn@arm.com>2020-03-11 21:25:07 +0000
commit2bbfaa784c0ea2e2b239470cfbe633026d53c9cb (patch)
tree0de6e92da7a3b6f2bff919cefe7a54a7aa679a80 /include/armnn/IRuntime.hpp
parent5238aff21baf0b35c36ab0cc72c7a46888e3bd08 (diff)
downloadarmnn-2bbfaa784c0ea2e2b239470cfbe633026d53c9cb.tar.gz
IVGCVSW-3726 Doxygen touch-up
* Doxygen comment touch-ups * Fixed markup in .dox files * Fixed stylesheet * Doxyfile changes * Added logo file * Added header file Signed-off-by: Ryan OShea <Ryan.OShea2@arm.com> Change-Id: I94c7f5a6923a0bbb5c6ed610f1f55d57e2bb8a49
Diffstat (limited to 'include/armnn/IRuntime.hpp')
-rw-r--r--include/armnn/IRuntime.hpp10
1 files changed, 7 insertions, 3 deletions
diff --git a/include/armnn/IRuntime.hpp b/include/armnn/IRuntime.hpp
index 49c18113b3..712355bb3a 100644
--- a/include/armnn/IRuntime.hpp
+++ b/include/armnn/IRuntime.hpp
@@ -50,11 +50,11 @@ public:
/// It will also be updated with new tuned parameters if it is configured to do so.
std::shared_ptr<IGpuAccTunedParameters> m_GpuAccTunedParameters;
- // Setting this flag will allow the user to obtain GPU profiling information from the runtime.
+ /// Setting this flag will allow the user to obtain GPU profiling information from the runtime.
bool m_EnableGpuProfiling;
- // Setting this value will override the paths set by the DYNAMIC_BACKEND_PATHS compiler directive
- // Only a single path is allowed for the override
+ /// Setting this value will override the paths set by the DYNAMIC_BACKEND_PATHS compiler directive
+ /// Only a single path is allowed for the override
std::string m_DynamicBackendsPath;
struct ExternalProfilingOptions
@@ -78,6 +78,7 @@ public:
/// Pass backend specific options.
///
/// For example, to enable GpuAcc tuning add the following
+ /// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~.cpp
/// m_BackendOption.emplace_back(
/// BackendOptions{"GpuAcc",
/// {
@@ -85,16 +86,19 @@ public:
/// {"TuningFile", filename}
/// }
/// });
+ /// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
/// Execute representative workloads through the runtime to generate tuning data.
/// The tuning file is written once the runtime is destroyed
/// To execute with the tuning data, start up with just the tuning file specified.
+ /// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~.cpp
/// m_BackendOption.emplace_back(
/// BackendOptions{"GpuAcc",
/// {
/// {"TuningFile", filename}
/// }
/// });
+ /// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
/// The following backend options are available:
/// GpuAcc: