From 04c56a0618f668fac288fb2070fcf200a83aebc6 Mon Sep 17 00:00:00 2001
From: Robin Gareus <robin@gareus.org>
Date: Tue, 12 Apr 2016 17:03:44 +0200
Subject: some strategic documentation

Prevent class descriptions inheriting the doc from PBD:Stateful by
adding some specific doc.
---
 libs/pbd/pbd/command.h      | 1 +
 libs/pbd/pbd/controllable.h | 3 +--
 libs/pbd/pbd/id.h           | 1 +
 3 files changed, 3 insertions(+), 2 deletions(-)

(limited to 'libs/pbd')

diff --git a/libs/pbd/pbd/command.h b/libs/pbd/pbd/command.h
index 337140e786..a9b313f4fa 100644
--- a/libs/pbd/pbd/command.h
+++ b/libs/pbd/pbd/command.h
@@ -28,6 +28,7 @@
 #include "pbd/signals.h"
 #include "pbd/statefuldestructible.h"
 
+/** Base class for Undo/Redo commands and changesets */
 class LIBPBD_API Command : public PBD::StatefulDestructible, public PBD::ScopedConnectionList
 {
 public:
diff --git a/libs/pbd/pbd/controllable.h b/libs/pbd/pbd/controllable.h
index 5ac6895d6f..cd26ff019f 100644
--- a/libs/pbd/pbd/controllable.h
+++ b/libs/pbd/pbd/controllable.h
@@ -37,7 +37,7 @@ class XMLNode;
 
 namespace PBD {
 
-/* This is a pure virtual class to represent a scalar control.
+/** This is a pure virtual class to represent a scalar control.
  *
  * Note that it contains no storage/state for the controllable thing that it
  * represents. Derived classes must provide set_value()/get_value() methods,
@@ -49,7 +49,6 @@ namespace PBD {
  * as a control whose value can range between 0 and 1.0.
  *
  */
-
 class LIBPBD_API Controllable : public PBD::StatefulDestructible {
   public:
 	enum Flag {
diff --git a/libs/pbd/pbd/id.h b/libs/pbd/pbd/id.h
index 1f33e6d732..5316e7c20e 100644
--- a/libs/pbd/pbd/id.h
+++ b/libs/pbd/pbd/id.h
@@ -29,6 +29,7 @@
 
 namespace PBD {
 
+/** a unique ID to identify objects numerically */
 class LIBPBD_API ID {
   public:
 	ID ();
-- 
cgit v1.2.3