Merge branch 'master' of git.lyx.org:lyx

[lyx.git] / src / Layout.h

diff --git a/src/Layout.h b/src/Layout.h
index 913546fd744c37e3f993b13390e1f01f017cb871..d0abcec6abb2d7966062e8be2c9b9d3e8ba19056 100644 (file)
--- a/src/Layout.h
+++ b/src/Layout.h
@@ -108,13 +108,18 @@ public:
        ///
        typedef std::map<std::string, latexarg> LaTeXArgMap;
        ///
-       LaTeXArgMap args() const;
-       ///
        LaTeXArgMap const & latexargs() const { return latexargs_; }
        ///
        LaTeXArgMap const & postcommandargs() const { return postcommandargs_; }
        ///
        LaTeXArgMap const & itemargs() const { return itemargs_; }
+       /// Returns latexargs() + postcommandargs() + itemargs().
+       /// But note that it returns a *copy*, not a reference, so do not do
+       /// anything like:
+       ///   Layout::LaTeXArgMap::iterator it = args().begin();
+       ///   Layout::LaTeXArgMap::iterator en = args().end();
+       /// Those are iterators for different containers.
+       LaTeXArgMap args() const;
        ///
        int optArgs() const;
        ///