X-Git-Url: http://sigrok.org/gitweb/?a=blobdiff_plain;f=pv%2Fviews%2Ftrace%2Fheader.hpp;h=32b7e6128bddb4f4f82a88c241843fe87c32bec0;hb=4b018bf1eeed0f7b80120d41d7881673a2f29e61;hp=0038abb1a8f9528825908b794537025fe7d2e518;hpb=1573bf16ba50d1c023ad3a9ce596f0ab6eaeacff;p=pulseview.git
diff --git a/pv/views/trace/header.hpp b/pv/views/trace/header.hpp
index 0038abb1..32b7e612 100644
--- a/pv/views/trace/header.hpp
+++ b/pv/views/trace/header.hpp
@@ -17,8 +17,8 @@
* along with this program; if not, see .
*/
-#ifndef PULSEVIEW_PV_VIEWS_TRACEVIEW_HEADER_HPP
-#define PULSEVIEW_PV_VIEWS_TRACEVIEW_HEADER_HPP
+#ifndef PULSEVIEW_PV_VIEWS_TRACE_HEADER_HPP
+#define PULSEVIEW_PV_VIEWS_TRACE_HEADER_HPP
#include
#include
@@ -37,6 +37,12 @@ class TraceTreeItem;
class View;
class ViewItem;
+/**
+ * The Header class provides an area for @ref Trace labels to be shown,
+ * trace-related settings to be edited, trace groups to be shown and similar.
+ * Essentially, it is the main management area of the @ref View itself and
+ * shown on the left-hand side of the trace area.
+ */
class Header : public MarginWidget
{
Q_OBJECT
@@ -88,4 +94,4 @@ private Q_SLOTS:
} // namespace views
} // namespace pv
-#endif // PULSEVIEW_PV_VIEWS_TRACEVIEW_HEADER_HPP
+#endif // PULSEVIEW_PV_VIEWS_TRACE_HEADER_HPP