aboutsummaryrefslogtreecommitdiff
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
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
-rw-r--r--docs/00_introduction.dox3
-rw-r--r--docs/01_parsers.dox11
-rw-r--r--docs/02_deserializer_serializer.dox2
-rw-r--r--docs/03_converter_quantizer.dox2
-rw-r--r--docs/04_backends.dox4
-rw-r--r--docs/05_other_tools.dox2
-rw-r--r--docs/Arm_NN_horizontal_blue.pngbin0 -> 16540 bytes
-rw-r--r--docs/Doxyfile4
-rw-r--r--docs/header.xhtml55
-rw-r--r--docs/stylesheet.css14
-rw-r--r--include/armnn/BackendId.hpp18
-rw-r--r--include/armnn/BackendOptions.hpp6
-rw-r--r--include/armnn/BackendRegistry.hpp2
-rw-r--r--include/armnn/DescriptorsFwd.hpp2
-rw-r--r--include/armnn/Exceptions.hpp6
-rw-r--r--include/armnn/IRuntime.hpp10
-rw-r--r--include/armnn/LayerVisitorBase.hpp2
-rw-r--r--include/armnn/Optional.hpp60
-rw-r--r--include/armnn/Tensor.hpp4
-rw-r--r--include/armnn/Types.hpp8
-rw-r--r--include/armnn/Version.hpp12
-rw-r--r--include/armnn/backends/IBackendContext.hpp4
-rw-r--r--include/armnn/backends/IBackendInternal.hpp10
-rw-r--r--include/armnn/backends/ITensorHandle.hpp2
-rw-r--r--include/armnn/backends/ITensorHandleFactory.hpp10
-rw-r--r--include/armnnUtils/DataLayoutIndexed.hpp12
-rw-r--r--include/armnnUtils/FloatingPointConverter.hpp4
27 files changed, 160 insertions, 109 deletions
diff --git a/docs/00_introduction.dox b/docs/00_introduction.dox
index 981e03387b..66006405f5 100644
--- a/docs/00_introduction.dox
+++ b/docs/00_introduction.dox
@@ -1,4 +1,4 @@
-/// Copyright (c) 2017 ARM Limited.
+/// Copyright (c) 2020 ARM Limited.
///
/// SPDX-License-Identifier: MIT
///
@@ -824,3 +824,4 @@ The instructions show how to build the ArmNN core library and the Boost, Protobu
**/
}
+
diff --git a/docs/01_parsers.dox b/docs/01_parsers.dox
index e73334744f..afa9b9c4f9 100644
--- a/docs/01_parsers.dox
+++ b/docs/01_parsers.dox
@@ -1,4 +1,4 @@
-/// Copyright (c) 2017 ARM Limited.
+/// Copyright (c) 2020 ARM Limited.
///
/// SPDX-License-Identifier: MIT
///
@@ -37,6 +37,7 @@ This reference guide provides a list of Caffe layers the Arm NN SDK currently su
## Although some other neural networks might work, Arm tests the Arm NN SDK with Caffe implementations of the following neural networks:
- AlexNet.
+- Cifar10.
- Inception-BN.
- Resnet_50, Resnet_101 and Resnet_152.
- VGG_CNN_S, VGG_16 and VGG_19.
@@ -44,9 +45,6 @@ This reference guide provides a list of Caffe layers the Arm NN SDK currently su
- Lenet.
- MobileNetv1.
-using these datasets:
-- Cifar10.
-
## The Arm NN SDK supports the following machine learning layers for Caffe networks:
- BatchNorm, in inference mode.
@@ -86,7 +84,7 @@ The Arm NN SDK ONNX parser currently only supports fp32 operators.
- Add
- See the ONNX [Add documentation](https://github.com/onnx/onnx/blob/master/docs/Operators.md#Add) for more information
--AveragePool
+- AveragePool
- See the ONNX [AveragePool documentation](https://github.com/onnx/onnx/blob/master/docs/Operators.md#AveragePool) for more information.
- Constant
- See the ONNX [Constant documentation](https://github.com/onnx/onnx/blob/master/docs/Operators.md#Constant) for more information.
@@ -209,7 +207,7 @@ The Arm NN SDK TensorFlow parser currently only supports fp32 operators.
- placeholder
- See the TensorFlow [placeholder documentation](https://www.tensorflow.org/api_docs/python/tf/placeholder) for more information.
- reduce_mean
- -See the TensorFlow [reduce_mean documentation](https://www.tensorflow.org/api_docs/python/tf/reduce_mean) for more information.
+ - See the TensorFlow [reduce_mean documentation](https://www.tensorflow.org/api_docs/python/tf/reduce_mean) for more information.
- relu
- See the TensorFlow [relu documentation](https://www.tensorflow.org/api_docs/python/tf/nn/relu) for more information.
- relu6
@@ -288,3 +286,4 @@ More machine learning operators will be supported in future releases.
**/
}
+
diff --git a/docs/02_deserializer_serializer.dox b/docs/02_deserializer_serializer.dox
index 1cd0516a1e..0bd677eb88 100644
--- a/docs/02_deserializer_serializer.dox
+++ b/docs/02_deserializer_serializer.dox
@@ -1,4 +1,4 @@
-/// Copyright (c) 2017 ARM Limited.
+/// Copyright (c) 2020 ARM Limited.
///
/// SPDX-License-Identifier: MIT
///
diff --git a/docs/03_converter_quantizer.dox b/docs/03_converter_quantizer.dox
index ebfacd473e..9b643f387a 100644
--- a/docs/03_converter_quantizer.dox
+++ b/docs/03_converter_quantizer.dox
@@ -1,4 +1,4 @@
-/// Copyright (c) 2017 ARM Limited.
+/// Copyright (c) 2020 ARM Limited.
///
/// SPDX-License-Identifier: MIT
///
diff --git a/docs/04_backends.dox b/docs/04_backends.dox
index cc6d01372e..e718895437 100644
--- a/docs/04_backends.dox
+++ b/docs/04_backends.dox
@@ -1,4 +1,4 @@
-/// Copyright (c) 2017 ARM Limited.
+/// Copyright (c) 2020 ARM Limited.
///
/// SPDX-License-Identifier: MIT
///
@@ -433,7 +433,7 @@ Layer Support API and the Workload Factory.
At the end of test, the runtime object goes out of scope and the dynamic backend instance is automatically destroyed, and the handle to
the shared object is closed.
-<br/><br/><br/><br/><br/>
+<br/><br/><br/><br/>
@section S13_dynamic_backend_guide Standalone Dynamic Backend Developer Guide
diff --git a/docs/05_other_tools.dox b/docs/05_other_tools.dox
index 898565443d..522e16f46a 100644
--- a/docs/05_other_tools.dox
+++ b/docs/05_other_tools.dox
@@ -1,4 +1,4 @@
-/// Copyright (c) 2017 ARM Limited.
+/// Copyright (c) 2020 ARM Limited.
///
/// SPDX-License-Identifier: MIT
///
diff --git a/docs/Arm_NN_horizontal_blue.png b/docs/Arm_NN_horizontal_blue.png
new file mode 100644
index 0000000000..3d27185240
--- /dev/null
+++ b/docs/Arm_NN_horizontal_blue.png
Binary files differ
diff --git a/docs/Doxyfile b/docs/Doxyfile
index 8f104cb41c..67a8eeb86e 100644
--- a/docs/Doxyfile
+++ b/docs/Doxyfile
@@ -74,7 +74,7 @@ PROJECT_BRIEF =
# pixels and the maximum width should not exceed 200 pixels. Doxygen will copy
# the logo to the output directory.
-PROJECT_LOGO =
+PROJECT_LOGO = ./docs/Arm_NN_horizontal_blue.png
# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path
# into which the generated documentation will be written. If a relative path is
@@ -1189,7 +1189,7 @@ HTML_FILE_EXTENSION = .xhtml
# of the possible markers and block names see the documentation.
# This tag requires that the tag GENERATE_HTML is set to YES.
-HTML_HEADER =
+HTML_HEADER = ./docs/header.xhtml
# The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each
# generated HTML page. If the tag is left blank doxygen will generate a standard
diff --git a/docs/header.xhtml b/docs/header.xhtml
new file mode 100644
index 0000000000..c08a619ba2
--- /dev/null
+++ b/docs/header.xhtml
@@ -0,0 +1,55 @@
+<!-- Copyright (c) 2020 ARM Limited. -->
+<!-- -->
+<!-- SPDX-License-Identifier: MIT -->
+<!-- -->
+<!-- HTML header for doxygen 1.8.13-->
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml">
+<head>
+<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
+<meta http-equiv="X-UA-Compatible" content="IE=9"/>
+<meta name="generator" content="Doxygen $doxygenversion"/>
+<meta name="robots" content="NOINDEX, NOFOLLOW" />
+<meta name="viewport" content="width=device-width, initial-scale=1"/>
+<!--BEGIN PROJECT_NAME--><title>$projectname: $title</title><!--END PROJECT_NAME-->
+<!--BEGIN !PROJECT_NAME--><title>$title</title><!--END !PROJECT_NAME-->
+<link href="$relpath^tabs.css" rel="stylesheet" type="text/css"/>
+<script type="text/javascript" src="$relpath^jquery.js"></script>
+<script type="text/javascript" src="$relpath^dynsections.js"></script>
+$treeview
+$search
+$mathjax
+<link href="$relpath^$stylesheet" rel="stylesheet" type="text/css" />
+$extrastylesheet
+</head>
+<body>
+<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
+
+<!--BEGIN TITLEAREA-->
+<div id="titlearea">
+<table cellspacing="0" cellpadding="0">
+ <tbody>
+ <tr style="height: 56px;">
+ <img alt="ArmNN" src="Arm_NN_horizontal_blue.png" style="max-width: 10rem; margin-top: .5rem; margin-left 10px"/>
+ <!--BEGIN PROJECT_NAME-->
+ <td style="padding-left: 0.5em;">
+ <div id="projectname">
+ <!--BEGIN PROJECT_NUMBER-->&#160;<span id="projectnumber">$projectnumber</span><!--END PROJECT_NUMBER-->
+ </div>
+ <!--BEGIN PROJECT_BRIEF--><div id="projectbrief">$projectbrief</div><!--END PROJECT_BRIEF-->
+ </td>
+ <!--END PROJECT_NAME-->
+ <!--BEGIN !PROJECT_NAME-->
+ <!--END !PROJECT_NAME-->
+ <!--BEGIN DISABLE_INDEX-->
+ <!--BEGIN SEARCHENGINE-->
+ <td>$searchbox</td>
+ <td><p>Hello World</p></td>
+ <!--END SEARCHENGINE-->
+ <!--END DISABLE_INDEX-->
+ </tr>
+ </tbody>
+</table>
+</div>
+<!--END TITLEAREA-->
+<!-- end header part -->
diff --git a/docs/stylesheet.css b/docs/stylesheet.css
index f6ed8aadb9..ea7f4dccc0 100644
--- a/docs/stylesheet.css
+++ b/docs/stylesheet.css
@@ -1,7 +1,7 @@
+/* Copyright (c) 2020 ARM Limited. */
/* Changes to tabs.css */
.tabs, .tabs2, .tabs3 {
- /* box-shadow: 0px 5px 30px rgba(0, 0, 0, 0.3); */
position: relative;
}
@@ -110,6 +110,8 @@ a.codeRef, a.codeRef:visited {
div.fragment {
background-color: #FCFCFC;
border: 1px solid #CFCFCF;
+ padding: 8px;
+ margin: 10px 2px;
}
div.line.glow {
@@ -124,10 +126,6 @@ body {
background-color: #007fa3;
}
-.memitem.glow {
- /* box-shadow: 0 0 15px orange; */
-}
-
.memproto, dl.reflist dt {
border-top: 1px solid #B8B8B8;
border-left: 1px solid #B8B8B8;
@@ -168,12 +166,6 @@ dl.note
border-color: #f68a33;
}
-#projectlogo
-{
- width:150px;
- text-align:left;
-}
-
#projectname
{
font: 200% Tahoma, Arial,sans-serif;
diff --git a/include/armnn/BackendId.hpp b/include/armnn/BackendId.hpp
index 36f298741c..c94cd66661 100644
--- a/include/armnn/BackendId.hpp
+++ b/include/armnn/BackendId.hpp
@@ -14,10 +14,10 @@
namespace armnn
{
-//
-// The Compute enum is now deprecated and it is now
-// being replaced by BackendId
-//
+///
+/// The Compute enum is now deprecated and it is now
+/// being replaced by BackendId
+///
enum class Compute
{
Undefined = 0,
@@ -111,8 +111,8 @@ public:
return m_Id == other.m_Id;
}
- // comparison against objects from which the
- // BackendId can be constructed
+ /// comparison against objects from which the
+ /// BackendId can be constructed
template <typename O>
bool operator==(const O& other) const
{
@@ -147,9 +147,9 @@ private:
namespace std
{
-// make BackendId compatible with std hashtables by reusing the hash
-// function for strings.
-// Note this must come *before* the first use of unordered_set<BackendId>.
+/// make BackendId compatible with std hashtables by reusing the hash
+/// function for strings.
+/// Note this must come *before* the first use of unordered_set<BackendId>.
template <>
struct hash<armnn::BackendId>
{
diff --git a/include/armnn/BackendOptions.hpp b/include/armnn/BackendOptions.hpp
index a1b6b09cad..d7ccbd4b57 100644
--- a/include/armnn/BackendOptions.hpp
+++ b/include/armnn/BackendOptions.hpp
@@ -27,7 +27,7 @@ private:
};
public:
- // Very basic type safe variant
+ /// Very basic type safe variant
class Var
{
@@ -39,7 +39,7 @@ public:
explicit Var(const char* s) : m_Vals(s), m_Type(VarTypes::String) {};
explicit Var(std::string s) : m_Vals(s), m_Type(VarTypes::String) {};
- //Disallow implicit conversions from types not explicitly allowed below.
+ /// Disallow implicit conversions from types not explicitly allowed below.
template<typename DisallowedType>
Var(DisallowedType)
{
@@ -161,7 +161,7 @@ public:
String,
};
- // Union of potential type values.
+ /// Union of potential type values.
union Vals
{
int i;
diff --git a/include/armnn/BackendRegistry.hpp b/include/armnn/BackendRegistry.hpp
index a0cfee9391..1aaa11c55c 100644
--- a/include/armnn/BackendRegistry.hpp
+++ b/include/armnn/BackendRegistry.hpp
@@ -48,7 +48,7 @@ public:
protected:
using FactoryStorage = std::unordered_map<BackendId, FactoryFunction>;
- // For testing only
+ /// For testing only
static void Swap(BackendRegistry& instance, FactoryStorage& other);
private:
diff --git a/include/armnn/DescriptorsFwd.hpp b/include/armnn/DescriptorsFwd.hpp
index 144c1ef7fd..1298c1ce01 100644
--- a/include/armnn/DescriptorsFwd.hpp
+++ b/include/armnn/DescriptorsFwd.hpp
@@ -46,7 +46,7 @@ struct ViewsDescriptor;
using ConcatDescriptor = OriginsDescriptor;
using DepthToSpaceDescriptor = SpaceToDepthDescriptor;
using LogSoftmaxDescriptor = SoftmaxDescriptor;
-// MergerDescriptor is deprecated, use ConcatDescriptor instead
+/// MergerDescriptor is deprecated, use ConcatDescriptor instead
using MergerDescriptor = OriginsDescriptor;
using SplitterDescriptor = ViewsDescriptor;
diff --git a/include/armnn/Exceptions.hpp b/include/armnn/Exceptions.hpp
index 05b740614d..a83e31a71e 100644
--- a/include/armnn/Exceptions.hpp
+++ b/include/armnn/Exceptions.hpp
@@ -48,12 +48,12 @@ class Exception : public std::exception
public:
explicit Exception(const std::string& message);
- // exception with context
+ /// exception with context
explicit Exception(const std::string& message,
const CheckLocation& location);
- // preserving previous exception context
- // and adding local context information
+ /// preserving previous exception context
+ /// and adding local context information
explicit Exception(const Exception& other,
const std::string& message,
const CheckLocation& location);
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:
diff --git a/include/armnn/LayerVisitorBase.hpp b/include/armnn/LayerVisitorBase.hpp
index 511917cd19..9335ff8b0b 100644
--- a/include/armnn/LayerVisitorBase.hpp
+++ b/include/armnn/LayerVisitorBase.hpp
@@ -20,7 +20,7 @@ struct VisitorNoThrowPolicy
static void Apply(const std::string&) {}
};
-// Visitor base class with empty implementations.
+/// Visitor base class with empty implementations.
template<typename DefaultPolicy>
class LayerVisitorBase : public ILayerVisitor
{
diff --git a/include/armnn/Optional.hpp b/include/armnn/Optional.hpp
index 863b122716..677152636a 100644
--- a/include/armnn/Optional.hpp
+++ b/include/armnn/Optional.hpp
@@ -9,30 +9,30 @@
#include <cstring>
#include <type_traits>
-// Optional is a drop in replacement for std::optional until we migrate
-// to c++-17. Only a subset of the optional features are implemented that
-// we intend to use in ArmNN.
+/// Optional is a drop in replacement for std::optional until we migrate
+/// to c++-17. Only a subset of the optional features are implemented that
+/// we intend to use in ArmNN.
-// There are two distinct implementations here:
-//
-// 1, for normal constructable/destructable types and reference types
-// 2, for reference types
+/// There are two distinct implementations here:
+///
+/// 1, for normal constructable/destructable types and reference types
+/// 2, for reference types
-// The std::optional features we support are:
-//
-// - has_value() and operator bool() to tell if the optional has a value
-// - value() returns a reference to the held object
-//
+/// The std::optional features we support are:
+///
+/// - has_value() and operator bool() to tell if the optional has a value
+/// - value() returns a reference to the held object
+///
namespace armnn
{
-// EmptyOptional is used to initialize the Optional class in case we want
-// to have default value for an Optional in a function declaration.
+/// EmptyOptional is used to initialize the Optional class in case we want
+/// to have default value for an Optional in a function declaration.
struct EmptyOptional {};
-// Disambiguation tag that can be passed to the constructor to indicate that
-// the contained object should be constructed in-place
+/// Disambiguation tag that can be passed to the constructor to indicate that
+/// the contained object should be constructed in-place
struct ConstructInPlace
{
explicit ConstructInPlace() = default;
@@ -40,8 +40,8 @@ struct ConstructInPlace
#define CONSTRUCT_IN_PLACE armnn::ConstructInPlace{}
-// OptionalBase is the common functionality between reference and non-reference
-// optional types.
+/// OptionalBase is the common functionality between reference and non-reference
+/// optional types.
class OptionalBase
{
public:
@@ -72,11 +72,11 @@ protected:
bool m_HasValue;
};
-//
-// The default implementation is the non-reference case. This
-// has an unsigned char array for storing the optional value which
-// is in-place constructed there.
-//
+///
+/// The default implementation is the non-reference case. This
+/// has an unsigned char array for storing the optional value which
+/// is in-place constructed there.
+///
template <bool IsReference, typename T>
class OptionalReferenceSwitch : public OptionalBase
{
@@ -182,11 +182,11 @@ private:
alignas(alignof(T)) unsigned char m_Storage[sizeof(T)];
};
-//
-// This is the special case for reference types. This holds a pointer
-// to the referenced type. This doesn't own the referenced memory and
-// it never calls delete on the pointer.
-//
+///
+/// This is the special case for reference types. This holds a pointer
+/// to the referenced type. This doesn't own the referenced memory and
+/// it never calls delete on the pointer.
+///
template <typename T>
class OptionalReferenceSwitch<true, T> : public OptionalBase
{
@@ -298,8 +298,8 @@ public:
}
};
-// Utility template that constructs an object of type T in-place and wraps
-// it inside an Optional<T> object
+/// Utility template that constructs an object of type T in-place and wraps
+/// it inside an Optional<T> object
template<typename T, class... Args>
Optional<T> MakeOptional(Args&&... args)
{
diff --git a/include/armnn/Tensor.hpp b/include/armnn/Tensor.hpp
index d41cbb4b70..012b950004 100644
--- a/include/armnn/Tensor.hpp
+++ b/include/armnn/Tensor.hpp
@@ -177,8 +177,8 @@ public:
MemoryType GetMemoryArea() const { return m_MemoryArea; }
protected:
- // Protected destructor to stop users from making these
- // (could still new one on the heap and then leak it...)
+ /// Protected destructor to stop users from making these
+ /// (could still new one on the heap and then leak it...)
~BaseTensor() {}
MemoryType m_MemoryArea;
diff --git a/include/armnn/Types.hpp b/include/armnn/Types.hpp
index 29a0d4e364..9779958ee0 100644
--- a/include/armnn/Types.hpp
+++ b/include/armnn/Types.hpp
@@ -17,7 +17,7 @@ namespace armnn
constexpr unsigned int MaxNumOfTensorDimensions = 5U;
-// The lowest performance data capture interval we support is 10 miliseconds.
+/// The lowest performance data capture interval we support is 10 miliseconds.
constexpr unsigned int LOWEST_CAPTURE_PERIOD = 10000u;
/// @enum Status enumeration
@@ -308,7 +308,7 @@ struct ProfilingStaticGuid : public ProfilingGuid
namespace std
{
-// make ProfilingGuid hashable
+/// make ProfilingGuid hashable
template<>
struct hash<armnn::profiling::ProfilingGuid>
{
@@ -318,7 +318,7 @@ struct hash<armnn::profiling::ProfilingGuid>
}
};
-// make ProfilingDynamicGuid hashable
+/// make ProfilingDynamicGuid hashable
template<>
struct hash<armnn::profiling::ProfilingDynamicGuid>
{
@@ -328,7 +328,7 @@ struct hash<armnn::profiling::ProfilingDynamicGuid>
}
};
-// make ProfilingStaticGuid hashable
+/// make ProfilingStaticGuid hashable
template<>
struct hash<armnn::profiling::ProfilingStaticGuid>
{
diff --git a/include/armnn/Version.hpp b/include/armnn/Version.hpp
index 7a8553704f..1b76a0614a 100644
--- a/include/armnn/Version.hpp
+++ b/include/armnn/Version.hpp
@@ -5,7 +5,7 @@
#pragma once
-// Macro utils
+/// Macro utils
#define STRINGIFY_VALUE(s) STRINGIFY_MACRO(s)
#define STRINGIFY_MACRO(s) #s
#define CONCAT_VALUE(a, b, c) CONCAT_MACRO(a, b, c)
@@ -16,9 +16,9 @@
#define ARMNN_MINOR_VERSION 02
#define ARMNN_PATCH_VERSION 00
-// ARMNN_VERSION: "YYYYMMPP"
-// where:
-// YYYY = 4-digit year number
-// MM = 2-digit month number
-// PP = 2-digit patch number
+/// ARMNN_VERSION: "YYYYMMPP"
+/// where:
+/// YYYY = 4-digit year number
+/// MM = 2-digit month number
+/// PP = 2-digit patch number
#define ARMNN_VERSION "20" STRINGIFY_VALUE(CONCAT_VALUE(ARMNN_MAJOR_VERSION, ARMNN_MINOR_VERSION, ARMNN_PATCH_VERSION))
diff --git a/include/armnn/backends/IBackendContext.hpp b/include/armnn/backends/IBackendContext.hpp
index de9824956f..b12c99f733 100644
--- a/include/armnn/backends/IBackendContext.hpp
+++ b/include/armnn/backends/IBackendContext.hpp
@@ -16,11 +16,11 @@ protected:
IBackendContext(const IRuntime::CreationOptions&) {}
public:
- // Before and after Load network events
+ /// Before and after Load network events
virtual bool BeforeLoadNetwork(NetworkId networkId) = 0;
virtual bool AfterLoadNetwork(NetworkId networkId) = 0;
- // Before and after Unload network events
+ /// Before and after Unload network events
virtual bool BeforeUnloadNetwork(NetworkId networkId) = 0;
virtual bool AfterUnloadNetwork(NetworkId networkId) = 0;
diff --git a/include/armnn/backends/IBackendInternal.hpp b/include/armnn/backends/IBackendInternal.hpp
index 6ad9bba546..6771e7b9f5 100644
--- a/include/armnn/backends/IBackendInternal.hpp
+++ b/include/armnn/backends/IBackendInternal.hpp
@@ -68,18 +68,18 @@ inline std::ostream& operator<<(std::ostream& os, const BackendVersion& backendV
class IBackendInternal : public IBackend
{
protected:
- // Creation must be done through a specific
- // backend interface.
+ /// Creation must be done through a specific
+ /// backend interface.
IBackendInternal() = default;
public:
- // Allow backends created by the factory function
- // to be destroyed through IBackendInternal.
+ /// Allow backends created by the factory function
+ /// to be destroyed through IBackendInternal.
~IBackendInternal() override = default;
using IWorkloadFactoryPtr = std::unique_ptr<IWorkloadFactory>;
using IBackendContextPtr = std::unique_ptr<IBackendContext>;
- // This is the bridge between backend and backend profiling we'll keep it in the backend namespace.
+ /// This is the bridge between backend and backend profiling we'll keep it in the backend namespace.
using IBackendProfilingContextPtr = std::shared_ptr<armnn::profiling::IBackendProfilingContext>;
using IBackendProfilingPtr = std::unique_ptr<armnn::profiling::IBackendProfiling>;
using OptimizationPtr = std::unique_ptr<Optimization>;
diff --git a/include/armnn/backends/ITensorHandle.hpp b/include/armnn/backends/ITensorHandle.hpp
index 73b902eb7c..3002115957 100644
--- a/include/armnn/backends/ITensorHandle.hpp
+++ b/include/armnn/backends/ITensorHandle.hpp
@@ -61,7 +61,7 @@ public:
/// \return a TensorShape filled with the number of elements for each dimension.
virtual TensorShape GetShape() const = 0;
- // Testing support to be able to verify and set tensor data content
+ /// Testing support to be able to verify and set tensor data content
virtual void CopyOutTo(void* memory) const = 0;
virtual void CopyInFrom(const void* memory) = 0;
diff --git a/include/armnn/backends/ITensorHandleFactory.hpp b/include/armnn/backends/ITensorHandleFactory.hpp
index 03abe18aa9..cd094d2783 100644
--- a/include/armnn/backends/ITensorHandleFactory.hpp
+++ b/include/armnn/backends/ITensorHandleFactory.hpp
@@ -19,8 +19,8 @@ class ITensorHandleFactory
{
public:
using FactoryId = std::string;
- static const FactoryId LegacyFactoryId; // Use the workload factory to create the tensor handle
- static const FactoryId DeferredFactoryId; // Some TensorHandleFactory decisions are deferred to run-time
+ static const FactoryId LegacyFactoryId; /// Use the workload factory to create the tensor handle
+ static const FactoryId DeferredFactoryId; /// Some TensorHandleFactory decisions are deferred to run-time
virtual ~ITensorHandleFactory() {}
@@ -33,9 +33,9 @@ public:
virtual std::unique_ptr<ITensorHandle> CreateTensorHandle(const TensorInfo& tensorInfo,
DataLayout dataLayout) const = 0;
- // Utility Functions for backends which require TensorHandles to have unmanaged memory.
- // These should be overloaded if required to facilitate direct import of input tensors
- // and direct export of output tensors.
+ /// Utility Functions for backends which require TensorHandles to have unmanaged memory.
+ /// These should be overloaded if required to facilitate direct import of input tensors
+ /// and direct export of output tensors.
virtual std::unique_ptr<ITensorHandle> CreateTensorHandle(const TensorInfo& tensorInfo,
const bool IsMemoryManaged) const
{
diff --git a/include/armnnUtils/DataLayoutIndexed.hpp b/include/armnnUtils/DataLayoutIndexed.hpp
index 03404bda5d..c6701f7d5c 100644
--- a/include/armnnUtils/DataLayoutIndexed.hpp
+++ b/include/armnnUtils/DataLayoutIndexed.hpp
@@ -13,7 +13,7 @@
namespace armnnUtils
{
-// Provides access to the appropriate indexes for Channels, Height and Width based on DataLayout
+/// Provides access to the appropriate indexes for Channels, Height and Width based on DataLayout
class DataLayoutIndexed
{
public:
@@ -36,25 +36,25 @@ public:
BOOST_ASSERT( widthIndex < shape[m_WidthIndex] ||
( shape[m_WidthIndex] == 0 && widthIndex == 0) );
- // Offset the given indices appropriately depending on the data layout
+ /// Offset the given indices appropriately depending on the data layout
switch (m_DataLayout)
{
case armnn::DataLayout::NHWC:
batchIndex *= shape[1] * shape[2] * shape[3]; // batchIndex *= heightIndex * widthIndex * channelIndex
heightIndex *= shape[m_WidthIndex] * shape[m_ChannelsIndex];
widthIndex *= shape[m_ChannelsIndex];
- // channelIndex stays unchanged
+ /// channelIndex stays unchanged
break;
case armnn::DataLayout::NCHW:
default:
batchIndex *= shape[1] * shape[2] * shape[3]; // batchIndex *= heightIndex * widthIndex * channelIndex
channelIndex *= shape[m_HeightIndex] * shape[m_WidthIndex];
heightIndex *= shape[m_WidthIndex];
- // widthIndex stays unchanged
+ /// widthIndex stays unchanged
break;
}
- // Get the value using the correct offset
+ /// Get the value using the correct offset
return batchIndex + channelIndex + heightIndex + widthIndex;
}
@@ -65,7 +65,7 @@ private:
unsigned int m_WidthIndex;
};
-// Equality methods
+/// Equality methods
bool operator==(const armnn::DataLayout& dataLayout, const DataLayoutIndexed& indexed);
bool operator==(const DataLayoutIndexed& indexed, const armnn::DataLayout& dataLayout);
diff --git a/include/armnnUtils/FloatingPointConverter.hpp b/include/armnnUtils/FloatingPointConverter.hpp
index a2244735dc..68c24cdc6e 100644
--- a/include/armnnUtils/FloatingPointConverter.hpp
+++ b/include/armnnUtils/FloatingPointConverter.hpp
@@ -13,8 +13,8 @@ namespace armnnUtils
class FloatingPointConverter
{
public:
- // Converts a buffer of FP32 values to FP16, and stores in the given dstFloat16Buffer.
- // dstFloat16Buffer should be (numElements * 2) in size
+ /// Converts a buffer of FP32 values to FP16, and stores in the given dstFloat16Buffer.
+ /// dstFloat16Buffer should be (numElements * 2) in size
static void ConvertFloat32To16(const float *srcFloat32Buffer, size_t numElements, void *dstFloat16Buffer);
static void ConvertFloat16To32(const void *srcFloat16Buffer, size_t numElements, float *dstFloat32Buffer);