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
diff --git a/include/armnn/IRuntime.hpp b/include/armnn/IRuntime.hpp
index 49c1811..712355b 100644
--- a/include/armnn/IRuntime.hpp
+++ b/include/armnn/IRuntime.hpp
@@ -50,11 +50,11 @@
/// 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 @@
/// Pass backend specific options.
///
/// For example, to enable GpuAcc tuning add the following
+ /// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~.cpp
/// m_BackendOption.emplace_back(
/// BackendOptions{"GpuAcc",
/// {
@@ -85,16 +86,19 @@
/// {"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: