Comment.

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

diff --git a/src/Buffer.h b/src/Buffer.h
index 6959efdd13f15e4cd1bb277db95a62d436bece00..8b5465c673d2a2979f5747bd5290f71926ca173d 100644 (file)
--- a/src/Buffer.h
+++ b/src/Buffer.h
@@ -305,7 +305,12 @@ public:
        void setParent(Buffer const *);
        Buffer const * parent() const;
 
-       /// Collect all relative buffers
+       /// Collect all relative buffers, in the order in which they appear.
+       /// I.e., the "root" Buffer is first, then its first child, then any
+       /// of its children, etc. However, there are no duplicates in this
+       /// list.
+       /// This is "stable", too, in the sense that it returns the same
+       /// thing from whichever Buffer it is called.
        ListOfBuffers allRelatives() const;
 
        /** Get the document's master (or \c this if this is not a