Trace View: Add doxygen comments to some classes

[pulseview.git] / pv / views / trace / signal.hpp

diff --git a/pv/views/trace/signal.hpp b/pv/views/trace/signal.hpp
index d763609d972abc322dc796e9aca32a2add66269f..7f88720f7943904142008b82d88f8103caefa464 100644 (file)
--- a/pv/views/trace/signal.hpp
+++ b/pv/views/trace/signal.hpp
@@ -44,6 +44,15 @@ class SignalData;
 namespace views {
 namespace trace {
 
 namespace views {
 namespace trace {
 

+/**
+ * The Signal class represents a series of numeric values that can be drawn.
+ * This is the main difference to the more generic @ref Trace class.
+ *
+ * It is generally accepted that Signal instances consider themselves to be
+ * individual channels on e.g. an oscilloscope, though it should be kept in
+ * mind that virtual signals (e.g. math) will also be served by the Signal
+ * class.
+ */

 class Signal : public Trace, public ViewItemOwner
 {
        Q_OBJECT
 class Signal : public Trace, public ViewItemOwner
 {
        Q_OBJECT