small changes to ButtonController usage

[lyx.git] / src / Floating.h

diff --git a/src/Floating.h b/src/Floating.h
index b845ea289e45257978f2f899b6d38d6a17a09e60..bb7b78d731417a05f01c325fc1ef45f6ce26e676 100644 (file)
--- a/src/Floating.h
+++ b/src/Floating.h
@@ -16,6 +16,12 @@
 #pragma interface
 #endif
 
+/** This is a "float layout" object. It contains the parameters for how to
+    handle the different kinds of floats, default ones and user created ones.
+    Objects of this class is stored in a container in FloatList. The different
+    InsetFloat(s) have a pointer/reference through the name of the Floating
+    so that it knows how the different floats should be handled.
+*/
 class Floating {
 public:
        ///