Trace View: Add doxygen comments to some classes

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

diff --git a/pv/views/trace/header.hpp b/pv/views/trace/header.hpp
index 0038abb1a8f9528825908b794537025fe7d2e518..5d2ba4b7ce1c9e794a5ffa8f27cf1c8b4b02f04c 100644 (file)
--- a/pv/views/trace/header.hpp
+++ b/pv/views/trace/header.hpp
@@ -37,6 +37,12 @@ class TraceTreeItem;
 class View;
 class ViewItem;
 
 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
 class Header : public MarginWidget
 {
        Q_OBJECT