Trace View: Add doxygen comments to some classes

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

diff --git a/pv/views/trace/flag.hpp b/pv/views/trace/flag.hpp
index 4f707bddf3caaa5d9c9fc233950769510041bf21..2df13ca805e3ee74e5a185a372fc55049c7c8c80 100644 (file)
--- a/pv/views/trace/flag.hpp
+++ b/pv/views/trace/flag.hpp
@@ -32,6 +32,10 @@ namespace pv {
 namespace views {
 namespace trace {
 
+/**
+ * The Flag class represents items on the @ref Ruler that mark important
+ * events on the timeline to the user. They are editable and thus non-static.
+ */
 class Flag : public TimeMarker, public enable_shared_from_this<Flag>
 {
        Q_OBJECT