X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2FIndicesList.h;h=7fab436d6b331df948dbd30ea7a0ba248f616f91;hb=4ddc9e2501400f8bdc35d4d1fe56f39c49e82115;hp=019c54835df336808cf935aa2324026992b2bbfa;hpb=c52bd08442214e4d768ee73886dee68e2b812cd1;p=lyx.git

diff --git a/src/IndicesList.h b/src/IndicesList.h
index 019c54835d..7fab436d6b 100644
--- a/src/IndicesList.h
+++ b/src/IndicesList.h
@@ -3,28 +3,12 @@
  * \file IndicesList.h
  * This file is part of LyX, the document processor.
  * Licence details can be found in the file COPYING.
+ *
  * \author Jürgen Spitzmüller
  *
  * Full author contact details are available in file CREDITS.
- *
- *
- * \class Index
- *
- * A class describing an Index type, such as "Index of Names".
- * Different Index types are used in splitted Indices
- *
- * An Index has a name and a shortcut notation. It uses a
- * user-specifyable GUI colour. All these can be set and
- * queried.
- *
- * \class IndicesList
- *
- * A class containing a vector of all defined indices within a
- * document. Has methods for outputting a '|'-separated string 
- * of all elements, and for adding, removing and renaming elements.
  */
 
-
 #ifndef INDICESLIST_H
 #define INDICESLIST_H
 
@@ -37,6 +21,23 @@
 
 namespace lyx {
 
+/**
+ * \class Index
+ *
+ * A class describing an Index type, such as "Index of Names".
+ * Different Index types are used in split Indices
+ *
+ * An Index has a name and a shortcut notation. It uses a
+ * user-specifiable GUI colour. All these can be set and
+ * queried.
+ *
+ * \class IndicesList
+ *
+ * A class containing a vector of all defined indices within a
+ * document. It has methods for outputting a '|'-separated string
+ * of all elements, and for adding, removing and renaming elements.
+ */
+
 class Index {
 public:
 	///
@@ -93,7 +94,7 @@ public:
 	Index * find(docstring const & name);
 	Index const * find(docstring const & name) const;
 
-	/** \returns the Index with the shortcut \c shortcut. 
+	/** \returns the Index with the shortcut \c shortcut.
 	 *  If not found, returns 0.
 	 */
 	Index * findShortcut(docstring const & shortcut);