From: Richard Heck <rgheck@lyx.org>
Date: Mon, 7 Apr 2014 01:53:54 +0000 (-0400)
Subject: Make some functions return const refs, and add a comment.
X-Git-Tag: 2.2.0alpha1~2029
X-Git-Url: https://git.lyx.org/gitweb/?a=commitdiff_plain;h=75aa0d61dba848cda39ceddcde9c2f3f0b9afbe8;p=lyx.git

Make some functions return const refs, and add a comment.
---

diff --git a/src/insets/InsetLayout.h b/src/insets/InsetLayout.h
index 74e1af9db6..83bbb2d0de 100644
--- a/src/insets/InsetLayout.h
+++ b/src/insets/InsetLayout.h
@@ -85,13 +85,18 @@ public:
 	FontInfo labelfont() const { return labelfont_; }
 	///
 	ColorCode bgcolor() const { return bgcolor_; }
-	///
+	/// 
+	Layout::LaTeXArgMap const & latexargs() const { return latexargs_; }
+	///
+	Layout::LaTeXArgMap const & postcommandargs() const { return postcommandargs_; }
+	/// Returns latexargs() + postcommandargs().
+	/// But note that it returns a *copy*, not a reference, so do not do 
+	/// anything like:
+	///   Layout::LaTeXArgMap it = args().begin();
+	///   Layout::LaTeXArgMap en = args().end();
+	/// Those are iterators for different containers.
 	Layout::LaTeXArgMap args() const;
 	///
-	Layout::LaTeXArgMap latexargs() const { return latexargs_; }
-	///
-	Layout::LaTeXArgMap postcommandargs() const { return postcommandargs_; }
-	///
 	unsigned int optArgs() const;
 	///
 	unsigned int requiredArgs() const;