From: Thibaut Cuvelier <tcuvelier@lyx.org>
Date: Mon, 25 Apr 2022 01:14:24 +0000 (+0200)
Subject: InsetIndex: add a few comments.
X-Git-Url: https://git.lyx.org/gitweb/?a=commitdiff_plain;h=b5418f0d29a022ff13e6ae6f9402dbbfd8b826bf;p=features.git

InsetIndex: add a few comments.
---

diff --git a/src/insets/InsetIndex.cpp b/src/insets/InsetIndex.cpp
index 72204c084d..9f8471e8bc 100644
--- a/src/insets/InsetIndex.cpp
+++ b/src/insets/InsetIndex.cpp
@@ -1241,6 +1241,7 @@ struct IndexEntry
 {
 	IndexEntry() = default;
 
+	/// Builds an entry for the index with the given LaTeX index entry `s` and a pointer to the index inset `d`.
 	IndexEntry(docstring const & s, DocIterator const & d, bool for_output = false)
 			: dit_(d)
 	{
@@ -1250,6 +1251,7 @@ struct IndexEntry
 		parseItem(subsub_, for_output);
 	}
 
+	/// Comparison between two entries only based on their LaTeX representation.
 	bool equal(IndexEntry const & rhs) const
 	{
 		return main_ == rhs.main_ && sub_ == rhs.sub_ && subsub_ == rhs.subsub_;