Trace View: Add doxygen comments to some classes

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

diff --git a/pv/views/trace/trace.hpp b/pv/views/trace/trace.hpp
index 88b4ea6b032a7d202896e4aa9264bb0ccb3aa7fe..66a98055d66ac3cde5f34dac53fb7c7a1ad70952 100644 (file)
--- a/pv/views/trace/trace.hpp
+++ b/pv/views/trace/trace.hpp
@@ -49,6 +49,16 @@ class Popup;
 namespace views {
 namespace trace {
 
+/**
+ * The Trace class represents a @ref TraceTreeItem which occupies some vertical
+ * space on the canvas and spans across its entire width, essentially showing
+ * a time series of values, events, objects or similar. While easily confused
+ * with @ref Signal, the difference is that Trace may represent anything that
+ * can be drawn, not just numeric values. One example is a @ref DecodeTrace.
+ *
+ * For this reason, Trace is more generic and contains properties and helpers
+ * that benefit any kind of time series items.
+ */
 class Trace : public TraceTreeItem
 {
        Q_OBJECT