X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2Fcounters.h;h=df9a0a6149b00255e3867142478684fc314a2609;hb=d9e6e32961860821ecc047039ae6c1a9dcc6e35d;hp=d737f995bd30e647fd0b90d4be2dda51c48e1759;hpb=960db78b52f3938c4c1757b435c6dfe8f4b2e937;p=lyx.git

diff --git a/src/counters.h b/src/counters.h
index d737f995bd..df9a0a6149 100644
--- a/src/counters.h
+++ b/src/counters.h
@@ -1,28 +1,24 @@
 // -*- C++ -*-
-/* This file is part of
- * ======================================================
+/**
+ * \file counters.h
+ * This file is part of LyX, the document processor.
+ * Licence details can be found in the file COPYING.
  *
- *           LyX, The Document Processor
+ * \author Lars Gullik Bjønnes
+ * \author Jean-Marc Lasgouttes
+ * \author John Levon
+ * \author Martin Vermeer
  *
- *           Copyright 1995 Matthias Ettrich
- *           Copyright 1995-2001 The LyX Team.
- *
- *
- * ====================================================== */
-
+ * Full author contact details are available in file CREDITS.
+ */
 
 #ifndef COUNTERS_H
 #define COUNTERS_H
 
-#ifdef __GNUG__
-#pragma interface
-#endif
-
-#include "LString.h"
 #include <map>
-#include <vector>
+#include <string>
 
-///
+/// This represents a single counter.
 class Counter {
 public:
 	///
@@ -37,61 +33,56 @@ public:
 	void step();
 	///
 	void reset();
-	///
-	string master() const;
-	///
-	void setMaster(string const & m);
-	///
-
+	/// Returns the master counter of this counter
+	std::string master() const;
+	/// sets the master counter for this counter
+	void setMaster(std::string const & m);
 private:
-	int value_;
 	///
-	string master_;
+	int value_;
+	/// contains master counter name; master counter is the counter
+	/// that, if stepped (incremented) zeroes this counter. E.g.
+	/// "subparagraph"'s master is "paragraph".
+	std::string master_;
 };
 
 
-/** This is a class of (La)TeX type counters. The counters is in a text
-    Style and can be reset by signals emitted from a single counter.
-*/
+/// This is a class of (La)TeX type counters.
+/// Every instantiation is an array of counters of type Counter.
 class Counters {
 public:
-	///
-	Counters();
-	///	
-	//~Counters();
-	///
-	void newCounter(string const & newc);
-	///
-	void newCounter(string const & newc, string const & oldc);
-	///
-	void set(string const & ctr, int val);
-	///
-	void addto(string const & ctr, int val);
-	///
-	int value(string const & ctr) const;
-	///
-	void step(string const & ctr);
-	///
-	void reset(string const & match = "");
-	///
-	void copy(Counters & from, Counters & to, string const & match = "");
-	///
-	string labelItem(string const & ctr,
-			string const & labeltype, 
-			string const & langtype = "latin",
-			bool first = false);
-	///
-	string numberLabel(string const & ctr,
-			string const & labeltype, 
-			string const & langtype = "latin",
-			int head = 0);
-	///
-	std::vector<string> enums, sects;
-	
+	/// Add a new counter to array.
+	void newCounter(std::string const & newc);
+	/// Add new counter having oldc as its master.
+	void newCounter(std::string const & newc, std::string const & oldc);
+	///
+	void set(std::string const & ctr, int val);
+	///
+	void addto(std::string const & ctr, int val);
+	///
+	int value(std::string const & ctr) const;
+	/// Step (increment by one) counter named by arg, and
+	/// zeroes slave counter(s) for which it is the master.
+	/// NOTE sub-slaves not zeroed! That happens at slave's
+	/// first step 0->1. Seems to be sufficient.
+	void step(std::string const & ctr);
+	/// Reset all counters.
+	void reset();
+	/// Reset counters matched by match string.
+	void reset(std::string const & match);
+	/// Copy counters whose name matches match from the &from to
+	/// the &to array of counters. Empty string matches all.
+	void copy(Counters & from, Counters & to, std::string const & match = std::string());
+	/// A complete expanded label, like 2.1.4 for a subsubsection
+	/// according to the given format
+	std::string counterLabel(std::string const & format);
 private:
-	///
-	typedef std::map<string, Counter> CounterList;
-	///
+	/// A counter label's single item, 1 for subsection number in
+	/// the 2.1.4 subsubsection number label.
+	std::string labelItem(std::string const & ctr, std::string const & numbertype);
+	/// Maps counter (layout) names to actual counters.
+	typedef std::map<std::string, Counter> CounterList;
+	/// Instantiate.
 	CounterList counterList;
 
 };