Finally add some comments to the currentBufferView() and documentBufferView() functions.

Text from Tommaso (adjusted to my own taste) from the devel-list.

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

diff --git a/src/frontends/LyXView.h b/src/frontends/LyXView.h
index 873590320227ea200ffee596b817f793493b8fd1..49d3619ffd5accf072ed61fb17f020a7fe9e8ce4 100644 (file)
--- a/src/frontends/LyXView.h
+++ b/src/frontends/LyXView.h
@@ -50,9 +50,16 @@ public:
 
        /// \name Generic accessor functions
        //@{
+       /// The current BufferView refers to the BufferView that has the focus,
+       /// including for example the one that is created when you use the
+       /// advanced search and replace pane.
        /// \return the currently selected buffer view.
        virtual BufferView * currentBufferView() = 0;
        virtual BufferView const * currentBufferView() const = 0;
+
+       /// The document BufferView always refers to the view's main document
+       /// BufferView. So, even if the BufferView in e.g., the advanced
+       /// search and replace pane has the focus.
        /// \return the current document buffer view.
        virtual BufferView * documentBufferView() = 0;
        virtual BufferView const * documentBufferView() const = 0;