* src/lyxlayout.h

	(LyXLayout::is_environment): Document

git-svn-id: svn://svn.lyx.org/lyx/lyx-devel/trunk@16737 a592a061-630c-0410-9148-cb99ea01b6c8

diff --git a/src/lyxlayout.h b/src/lyxlayout.h
index 2d12777bf6b48d09114c234b1393a92627c7f219..7cdff88aa062b1c0bd633e84b231b12e237de102 100644 (file)
--- a/src/lyxlayout.h
+++ b/src/lyxlayout.h
@@ -149,7 +149,13 @@ public:
        bool free_spacing;
        ///
        bool pass_thru;
-       ///
+       /**
+        * Whether this layout was declared with "Environment xxx" as opposed
+        * to "Style xxx". This is part of some unfinished generic environment
+        * handling (see also InsetEnvironment) started by Andre. No layout
+        * that is shipped with LyX has this flag set.
+        * Don't confuse this with isEnvironment()!
+        */
        bool is_environment;
        /// show this in toc
        int toclevel;