Routines for calculating numerical labels for BibTeX citations.

[lyx.git] / src / insets / InsetVSpace.h

diff --git a/src/insets/InsetVSpace.h b/src/insets/InsetVSpace.h
index 990e089f7f3b065994f3f681abe606283e219a7f..eeec30c1b8970025c5b40835fbcac5b04969943a 100644 (file)
--- a/src/insets/InsetVSpace.h
+++ b/src/insets/InsetVSpace.h
@@ -50,7 +50,11 @@ private:
        int plaintext(odocstream &, OutputParams const &) const;
        ///
        int docbook(odocstream &, OutputParams const &) const;
-       ///
+       /// Note that this returns the inset rather than writing it,
+       /// so it will actually be written after the present paragraph.
+       /// The normal case is that this inset will be on a line by
+       /// itself, and in that case the present paragraph will not,
+       /// in fact, appear at all.
        docstring xhtml(XHTMLStream &, OutputParams const &) const;
        ///
        void read(Lexer & lex);