diff options
author | Ryan OShea <Ryan.OShea2@arm.com> | 2020-02-12 16:15:27 +0000 |
---|---|---|
committer | Jim Flynn <jim.flynn@arm.com> | 2020-03-11 21:25:07 +0000 |
commit | 2bbfaa784c0ea2e2b239470cfbe633026d53c9cb (patch) | |
tree | 0de6e92da7a3b6f2bff919cefe7a54a7aa679a80 /include/armnn/backends | |
parent | 5238aff21baf0b35c36ab0cc72c7a46888e3bd08 (diff) | |
download | armnn-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/backends')
-rw-r--r-- | include/armnn/backends/IBackendContext.hpp | 4 | ||||
-rw-r--r-- | include/armnn/backends/IBackendInternal.hpp | 10 | ||||
-rw-r--r-- | include/armnn/backends/ITensorHandle.hpp | 2 | ||||
-rw-r--r-- | include/armnn/backends/ITensorHandleFactory.hpp | 10 |
4 files changed, 13 insertions, 13 deletions
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 { |