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

diff --git a/src/counters.h b/src/counters.h
index d737f995bd..da7bf4467d 100644
--- a/src/counters.h
+++ b/src/counters.h
@@ -14,15 +14,11 @@
 #ifndef COUNTERS_H
 #define COUNTERS_H
 
-#ifdef __GNUG__
-#pragma interface
-#endif
-
 #include "LString.h"
 #include <map>
-#include <vector>
 
-///
+
+/// This represents a single counter.
 class Counter {
 public:
 	///
@@ -37,31 +33,27 @@ public:
 	void step();
 	///
 	void reset();
-	///
+	/// Returns the master counter of this counter
 	string master() const;
-	///
+	/// sets the master counter for this counter
 	void setMaster(string const & m);
-	///
-
 private:
-	int value_;
 	///
+	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".
 	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();
-	///
+	/// Add a new counter to array.
 	void newCounter(string const & newc);
-	///
+	/// Add new counter having oldc as its master.
 	void newCounter(string const & newc, string const & oldc);
 	///
 	void set(string const & ctr, int val);
@@ -69,29 +61,36 @@ public:
 	void addto(string const & ctr, int val);
 	///
 	int value(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(string const & ctr);
-	///
-	void reset(string const & match = "");
-	///
-	void copy(Counters & from, Counters & to, string const & match = "");
-	///
+	/// Reset all counters.
+	void reset();
+	/// Reset counters matched by match string.
+	void reset(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, string const & match = string());
+	/// A numeric label's single item, like .1 for subsection number in
+	/// the 2.1.4 subsubsection number label. "first" indicates if this
+	/// is the first item to be displayed, usually chapter or section.
 	string labelItem(string const & ctr,
-			string const & labeltype, 
+			string const & labeltype,
 			string const & langtype = "latin",
 			bool first = false);
-	///
+	/// A complete numeric label, like 2.1.4 for a subsubsection.
+	/// "head" indicates sequence number of first item to be
+	/// displayed, e.g. 0 for chapter, 1 for section.
 	string numberLabel(string const & ctr,
-			string const & labeltype, 
+			string const & labeltype,
 			string const & langtype = "latin",
 			int head = 0);
-	///
-	std::vector<string> enums, sects;
-	
 private:
-	///
+	/// Maps counter (layout) names to actual counters.
 	typedef std::map<string, Counter> CounterList;
-	///
+	/// Instantiate.
 	CounterList counterList;
 
 };