Trace View: Add doxygen comments to some classes

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

diff --git a/pv/views/trace/timemarker.hpp b/pv/views/trace/timemarker.hpp
index 24ba9b0341bb331b4026f2285a08f423a5aa2059..1a2abb3251e7bc3a8a3caa6e4d63b150141ecffd 100644 (file)
--- a/pv/views/trace/timemarker.hpp
+++ b/pv/views/trace/timemarker.hpp
@@ -41,6 +41,10 @@ namespace trace {
 
 class View;
 
+/**
+ * The TimeMarker class represents items on the @ref Ruler that highlight a
+ * single point in time to the user. Aside from this, it is generic in nature.
+ */
 class TimeMarker : public TimeItem
 {
        Q_OBJECT