From 0acf594df2d98bf675cc67ed0bec5deddaedc777 Mon Sep 17 00:00:00 2001
From: Jean-Marc Lasgouttes <lasgouttes@lyx.org>
Date: Tue, 13 Apr 2021 10:33:42 +0200
Subject: [PATCH] Improve the description of Inset::inheritFont()

The existing descriptions were obsolete (see e.g. ticket #10263).
---
 src/insets/Inset.h        | 10 +++-------
 src/insets/InsetFloat.h   |  4 +---
 src/insets/InsetNote.h    |  4 +---
 src/insets/InsetTabular.h |  4 +---
 4 files changed, 6 insertions(+), 16 deletions(-)

diff --git a/src/insets/Inset.h b/src/insets/Inset.h
index ad79d17a5e..4396c9bc2a 100644
--- a/src/insets/Inset.h
+++ b/src/insets/Inset.h
@@ -586,13 +586,9 @@ public:
 	/// returns whether paragraph breaks can occur inside this inset
 	virtual bool allowMultiPar() const { return false; }
 	/**
-	 * The font is inherited from the parent for LaTeX export if this
-	 * method returns true. No open font changes are closed in front of
-	 * the inset for LaTeX export, and the font is inherited for all other
-	 * exports as well as on screen.
-	 * If this method returns false all open font changes are closed in
-	 * front of the inset for LaTeX export. The default font is used
-	 * inside the inset for all exports and on screen.
+	 * The font inside the inset is inherited from the parent for
+	 * LaTeX export if this method returns true, as well as on screen.
+	 * Otherwise the document default font is used.
 	 */
 	virtual bool inheritFont() const { return true; }
 	/**
diff --git a/src/insets/InsetFloat.h b/src/insets/InsetFloat.h
index 0fc0fba398..9d20a486cf 100644
--- a/src/insets/InsetFloat.h
+++ b/src/insets/InsetFloat.h
@@ -104,9 +104,7 @@ private:
 	docstring xhtml(XMLStream &, OutputParams const &) const override;
 	///
 	bool insetAllowed(InsetCode) const override;
-	/** returns false if, when outputting LaTeX, font changes should
-	    be closed before generating this inset. This is needed for
-	    insets that may contain several paragraphs */
+	///
 	bool inheritFont() const override { return false; }
 	///
 	bool getStatus(Cursor &, FuncRequest const &, FuncStatus &) const override;
diff --git a/src/insets/InsetNote.h b/src/insets/InsetNote.h
index aeab8f038b..32bb26bbf6 100644
--- a/src/insets/InsetNote.h
+++ b/src/insets/InsetNote.h
@@ -61,9 +61,7 @@ private:
 	InsetCode lyxCode() const override { return NOTE_CODE; }
 	///
 	docstring layoutName() const override;
-	/** returns false if, when outputting LaTeX, font changes should
-	    be closed before generating this inset. This is needed for
-	    insets that may contain several paragraphs */
+	///
 	bool inheritFont() const override { return params_.type == InsetNoteParams::Note; }
 	/// Is the content of this inset part of the output document?
 	bool producesOutput() const override
diff --git a/src/insets/InsetTabular.h b/src/insets/InsetTabular.h
index 1d1cf5712b..8d1be1b2a3 100644
--- a/src/insets/InsetTabular.h
+++ b/src/insets/InsetTabular.h
@@ -980,9 +980,7 @@ public:
 	bool canTrackChanges() const override { return true; }
 	///
 	bool canPaintChange(BufferView const &) const override { return true; }
-	/** returns false if, when outputting LaTeX, font changes should
-	    be closed before generating this inset. This is needed for
-	    insets that may contain several paragraphs */
+	///
 	bool inheritFont() const override { return false; }
 	///
 	bool allowMultiPar() const override;