Skip to content

Commit cdf9d6c

Browse files
committed
Updated documentation.
1 parent 98c304b commit cdf9d6c

File tree

2 files changed

+8
-0
lines changed

2 files changed

+8
-0
lines changed

power_overwhelming/src/collector.cpp

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@
1515
#include "power_overwhelming/convert_string.h"
1616

1717
#include "collector_impl.h"
18+
#include "sensor_desc.h"
1819
#include "sensor_utilities.h"
1920
#include "tinkerforge_sensor_impl.h"
2021

power_overwhelming/src/sensor_desc.h

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -87,6 +87,13 @@ namespace detail {
8787
/// Provides compile-time metadata for a sensor of type
8888
/// <see cref="TSensor" />.
8989
/// </summary>
90+
/// <remarks>
91+
/// <para>Implementors of new kinds of sensors must provide a full template
92+
/// specialisation of this type that describes the new sensor.</para>
93+
/// <para>For convenience, implementors should inherit from
94+
/// <see cref="detail::sensor_desc_base" /> to provide the type of the
95+
/// sensor and the test for the type name automatically.</para>
96+
/// </remarks>
9097
/// <typeparam name="TSensor">The type of the sensor described by the
9198
/// template instance.</typeparam>
9299
template<class TSensor> struct sensor_desc final { };

0 commit comments

Comments
 (0)