diff options
| author | Alex Gilday <alexander.gilday@arm.com> | 2018-03-21 13:54:09 +0000 |
|---|---|---|
| committer | Anthony Barbier <anthony.barbier@arm.com> | 2018-11-02 16:49:16 +0000 |
| commit | c357c47be8a3f210f9eee9a05cc13f1051b036d3 (patch) | |
| tree | a88ac857150da970a0862a3479b78c616d8aa1d3 /tests/framework/instruments/Instrument.h | |
| parent | 724079d6fce3bf6a05cd6c7b4884b132b27e9e90 (diff) | |
| download | ComputeLibrary-c357c47be8a3f210f9eee9a05cc13f1051b036d3.tar.gz | |
COMPMID-1008: Fix Doxygen issues
Change-Id: Ie73d8771f85d1f5b059f3a56f1bbd73c98e94a38
Reviewed-on: https://eu-gerrit-1.euhpc.arm.com/124723
Reviewed-by: Michalis Spyrou <michalis.spyrou@arm.com>
Tested-by: Jenkins <bsgcomp@arm.com>
Diffstat (limited to 'tests/framework/instruments/Instrument.h')
| -rw-r--r-- | tests/framework/instruments/Instrument.h | 16 |
1 files changed, 13 insertions, 3 deletions
diff --git a/tests/framework/instruments/Instrument.h b/tests/framework/instruments/Instrument.h index e25939a284..0df53f4210 100644 --- a/tests/framework/instruments/Instrument.h +++ b/tests/framework/instruments/Instrument.h @@ -57,13 +57,19 @@ public: template <typename T, ScaleFactor scale> static std::unique_ptr<Instrument> make_instrument(); + /** Default constructor. */ Instrument() = default; + /** Allow instances of this class to be copy constructed */ Instrument(const Instrument &) = default; - Instrument(Instrument &&) = default; + /** Allow instances of this class to be move constructed */ + Instrument(Instrument &&) = default; + /** Allow instances of this class to be copied */ Instrument &operator=(const Instrument &) = default; + /** Allow instances of this class to be moved */ Instrument &operator=(Instrument &&) = default; - virtual ~Instrument() = default; + /** Default destructor. */ + virtual ~Instrument() = default; /** Identifier for the instrument */ virtual std::string id() const = 0; @@ -74,9 +80,13 @@ public: /** Stop measuring. */ virtual void stop() = 0; + /** Map of measurements */ using MeasurementsMap = std::map<std::string, Measurement>; - /** Return the latest measurement. */ + /** Return the latest measurement. + * + * @return the latest measurement. + */ virtual MeasurementsMap measurements() const = 0; protected: |