adjust

[lyx.git] / src / Counters.h

diff --git a/src/Counters.h b/src/Counters.h
index 44ef598cfe67969d8985e314bb6cdbf3a0049b85..f2d4df71573f7abbec790e690f9471b0ff5ca813 100644 (file)
--- a/src/Counters.h
+++ b/src/Counters.h
@@ -40,23 +40,28 @@ public:
        void step();
        ///
        void reset();
-       /// Returns the master counter of this counter
+       /// Returns the master counter of this counter.
        docstring const & master() const;
-       /// Returns a LaTeX-like string to format the counter, similar
-       /// to LaTeX' \c \thesubsection.
+       /// Returns a LaTeX-like string to format the counter. 
+       /* This is similar to what one gets in LaTeX when using
+        * "\the<counter>".
+        */
        docstring const & labelString() const;
-       /// Returns a LaTeX-like string to format the counter in
-       /// appendix, similar to LaTeX' \c \thesubsection.
+       /// Returns a LaTeX-like string to format the counter in appendix.
+       /* This is similar to what one gets in LaTeX when using
+        * "\the<counter>" in an appendix.
+        */
        docstring const & labelStringAppendix() const;
 private:
        ///
        int value_;
-       /// contains master counter name; master counter is the counter
-       /// that, if stepped (incremented) zeroes this counter. E.g.
-       /// "subsection"'s master is "section".
+       /// contains master counter name.
+       /* The master counter is the counter that, if stepped
+        * (incremented) zeroes this counter. E.g. "subsection"'s
+        * master is "section".
+        */
        docstring master_;
-       // Contains a LaTeX-like string to format the counter, similar
-       // to LaTeX' \c \thesubsection.
+       // Contains a LaTeX-like string to format the counter.
        docstring labelstring_;
        // The same as labelstring_, but in appendices.
        docstring labelstringappendix_;
@@ -74,7 +79,7 @@ public:
                        docstring const & masterc,
                        docstring const & ls,
                        docstring const & lsa);
-       ///
+       /// Checks whether the given counter exists.
        bool hasCounter(docstring const & c) const;
        ///
        void set(docstring const & ctr, int val);
@@ -82,10 +87,11 @@ public:
        void addto(docstring const & ctr, int val);
        ///
        int value(docstring 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.
+       /// Increment by one counter named by arg, and zeroes slave
+       /// counter(s) for which it is the master.
+       /* Sub-slaves not zeroed! That happens at slave's first step
+        * 0->1. Seems to be sufficient.
+        */
        void step(docstring const & ctr);
        /// Reset all counters.
        void reset();
@@ -95,31 +101,35 @@ public:
        /// the &to array of counters. Empty string matches all.
        void copy(Counters & from, Counters & to,
                  docstring const & match = docstring());
-       /// returns the string representation of the counter.
+       /// returns the expanded string representation of the counter.
        docstring theCounter(docstring const & c);
-       /// A complete expanded label, like 2.1.4 for a subsubsection
-       /// according to the given format
+       /// Replace om format all the LaTeX-like macros that depend on
+       /// counters.
        docstring counterLabel(docstring const & format);
-       ///
+       /// Are we in apendix?
        bool appendix() const { return appendix_; };
-       ///
+       /// Set the state variable indicating whether we are in appendix.
        void appendix(bool a) { appendix_ = a; };
-       ///
+       /// Returns the current enclosing float.
        std::string const & current_float() const { return current_float_; }
-       ///
+       /// Sets the current enclosing float.
        void current_float(std::string const & f) { current_float_ = f; }
 private:
-       /// A counter label's single item, 1 for subsection number in
-       /// the 2.1.4 subsubsection number label.
+       /// Returns the value of the counter according to the
+       /// numbering scheme numbertype.
+       /* Available numbering schemes are arabic (1, 2,...), roman
+        * (i, ii,...), Roman (I, II,...), alph (a, b,...), Alpha (A,
+        * B,...) and hebrew.
+        */
        docstring labelItem(docstring const & ctr,
                            docstring const & numbertype);
        /// Maps counter (layout) names to actual counters.
        typedef std::map<docstring, Counter> CounterList;
        /// Instantiate.
        CounterList counterList;
-       ///
+       /// Are we in an appendix?
        bool appendix_;
-       ///
+       /// The current enclosing float.
        std::string current_float_;
 };