]> git.lyx.org Git - features.git/commitdiff
InsetIndex: add a few comments.
authorThibaut Cuvelier <tcuvelier@lyx.org>
Mon, 25 Apr 2022 01:14:24 +0000 (03:14 +0200)
committerThibaut Cuvelier <tcuvelier@lyx.org>
Sat, 30 Apr 2022 01:23:59 +0000 (03:23 +0200)
src/insets/InsetIndex.cpp

index 72204c084d9298b23c6e86d3092af7d4f8321596..9f8471e8bc26c06ffd72ca2f4a40551d2a493538 100644 (file)
@@ -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_;