From: fred <fred>
Date: Sun, 24 Mar 2002 19:31:50 +0000 (+0000)
Subject: lilypond-0.0.32
X-Git-Tag: release/1.5.59~5386
X-Git-Url: https://git.donarmstrong.com/?a=commitdiff_plain;h=a0b48515e037c5da766d27066ad0d02a76be7150;p=lilypond.git

lilypond-0.0.32
---

diff --git a/hdr/linespace.hh b/hdr/linespace.hh
index b9027754ce..1479d1e936 100644
--- a/hdr/linespace.hh
+++ b/hdr/linespace.hh
@@ -70,13 +70,15 @@ class Spacing_problem {
 
 public:
     /** solve the spacing problem
-          return the column positions, and the energy (last element)
-	  */
+      
+      @return the column positions, and the energy (last element)
+
+      */
     Array<Real> solve() const;
 
-    /// add a idealspacing to the problem.
+    
     /**
-      
+       add a idealspacing to the problem.
       
     One pair of columns can have no, one or more idealspacings,
     since they can be "summed" if the columns to which #i# refers are
@@ -85,8 +87,7 @@ public:
     void add_ideal(const Idealspacing *i);
     
     
-    /// add a col to the problem
-       /** columns have to be added left to right. The column contains
+    /** add a col to the problem. columns have to be added left to right. The column contains
       info on it's minimum width.
     */
     void add_column(const PCol *, bool fixed=false, Real fixpos=0.0);
diff --git a/hdr/pcol.hh b/hdr/pcol.hh
index 0e8ed3e677..21fdb698d9 100644
--- a/hdr/pcol.hh
+++ b/hdr/pcol.hh
@@ -6,8 +6,9 @@
 #include "plist.hh"
 #include "item.hh"
 
-/// stuff grouped vertically.
+
 /**
+   stuff grouped vertically.
     This is a class to address items vertically. It contains the data for:
     \begin{itemize}
     \item
@@ -17,13 +18,15 @@
     \item
     the linespacing problem
     \end{itemize}
-  */struct PCol {
+  */
+
+struct PCol {
     PointerList<const Item*> its;
     PointerList<const Spanner*> stoppers, starters;
     
 
-    /// prebreak is put before end of line.
-    /**
+
+    /** prebreak is put before end of line.
     if broken here, then (*this) column is discarded, and prebreak
     is put at end of line, owned by Col
     */
@@ -54,17 +57,17 @@
     void add(Item *i);
 
     /// Can this be broken? true eg. for bars. 
-    bool breakable()const;
+    bool breakable_b()const;
     
     Interval width() const;
     ~PCol();
     PCol(PCol * parent);
 
-    /// which col comes first?
     /**
+       which col comes first?.
     signed compare on columns.
 
-    return < 0 if c1 < c2.
+    @return < 0 if c1 < c2.
     */static int compare(const PCol &c1, const PCol &c2);
     
 
diff --git a/hdr/pscore.hh b/hdr/pscore.hh
index 3b47c65e44..f1f8dbbc96 100644
--- a/hdr/pscore.hh
+++ b/hdr/pscore.hh
@@ -8,7 +8,12 @@
 #include "pcol.hh"
 #include "pstaff.hh"
 
-/// all stuff which goes onto paper
+
+/** all stuff which goes onto paper. notes, signs, symbols in a score can be grouped in two ways:
+    horizontally (staffwise), and vertically (columns). #PScore#
+    contains the items, the columns and the staffs.
+ */
+
 struct PScore {
     Paperdef *paper_l_;
     
@@ -33,7 +38,7 @@ struct PScore {
     /// broken spanners
     IPointerList<Spanner*> broken_spans;
 
-    /****************/
+    /* *************** */
     /* CONSTRUCTION */
     
     PScore(Paperdef*);
@@ -42,8 +47,12 @@ struct PScore {
 
     void add(PStaff *);
     
-    /// add item
-    void typeset_item(Item *,  PCol *,PStaff*,int=1);
+
+    /** add an item.
+       add the item in specified containers. If breakstatus is set
+       properly, add it to the {pre,post}break of the pcol.
+       */
+    void typeset_item(Item *item_p,  PCol *pcol_l,PStaff*pstaf_l,int breakstatus=1);
 
     /// add a Spanner
     void typeset_spanner(Spanner*, PStaff*);
@@ -55,7 +64,9 @@ struct PScore {
     /* INSPECTION */
     Array<Item*> select_items(PStaff*, PCol*);
 
-    /// return argument as a cursor.
+     /**
+       @return argument as a cursor of the list
+       */
     PCursor<PCol *> find_col(const PCol *)const;
 
     /* MAIN ROUTINES */
@@ -91,8 +102,5 @@ private:
     /// delete unused columns
     void clean_cols();
 };
-/** notes, signs, symbols in a score can be grouped in two ways:
-    horizontally (staffwise), and vertically (columns). #PScore#
-    contains the items, the columns and the staffs.
- */
+
 #endif
diff --git a/hdr/qlp.hh b/hdr/qlp.hh
index 7bc667b956..ccfba72bb8 100644
--- a/hdr/qlp.hh
+++ b/hdr/qlp.hh
@@ -30,7 +30,9 @@ public:
     /// solve the problem using a projected gradient method
     Vector solve(Vector start) const;
     
-    /** return the number of variables in the problem */
+    /**
+      @return the number of variables in the problem
+      */
     int dim() const{
 	return lin.dim();
     }
@@ -61,8 +63,9 @@ public:
 
 };
 
-/// Quadratic programming with mixed linear constraints
+
 /**
+   Quadratic programming with mixed linear constraints.
   problem definition of a quadratic optimisation problem with linear
   inequality and equality constraints
 
diff --git a/hdr/qlpsolve.hh b/hdr/qlpsolve.hh
index 811556c362..7c9b8da341 100644
--- a/hdr/qlpsolve.hh
+++ b/hdr/qlpsolve.hh
@@ -40,15 +40,15 @@ public:
     Vector vec(int k) const { return opt->cons[k]; }
     Real rhs(int k) const { return opt->consrhs[k]; }
     
-    /// drop constraint
-    /** drop constraint k from the active set. k is the index of the
+
+    /** drop constraint. drop constraint k from the active set. k is the index of the
     constraint in #active#
     
     */
     void drop (int k);
     
-    ///     add constraint j
-    /**
+
+    /** add constraint j.
     add constraint j to the active set j is the index of the
     constraint in #inactive#   
     */
diff --git a/hdr/spanner.hh b/hdr/spanner.hh
index 097a592cd6..878d48d6e0 100644
--- a/hdr/spanner.hh
+++ b/hdr/spanner.hh
@@ -10,8 +10,8 @@
 #include "proto.hh"
 #include "staffelem.hh"
 
-/// a symbol which is attached between two columns.
-/** A spanner is a symbol which spans across several columns, so its
+
+/** a symbol which is attached between two columns. A spanner is a symbol which spans across several columns, so its
   final appearance can only be calculated after the breaking problem
   is solved.
 
@@ -42,9 +42,9 @@ struct Spanner:Staff_elem {
     Spanner *broken_at(PCol *c1,  PCol *c2) const;
     virtual Spanner* spanner() { return this; }
 protected:
-    /// clone a piece of  this spanner.
+
     /**
- 
+  clone a piece of  this spanner.
     PRE
     c1 >= start, c2  <= stop
     */
diff --git a/hdr/stem.hh b/hdr/stem.hh
index 962d1f4ba3..ccc02a6b59 100644
--- a/hdr/stem.hh
+++ b/hdr/stem.hh
@@ -1,5 +1,5 @@
 /*
-  stem.hh -- 
+  stem.hh -- declare Stem
 
   (c) 1996,97 Han-Wen Nienhuys
 */
@@ -10,8 +10,8 @@
 #include "varray.hh"
 #include "moment.hh"
 
-/// the rule attached to the ball
-/**
+
+/**the rule attached to the ball.
   takes care of:
 
   \begin{itemize}
@@ -22,11 +22,7 @@
   */
 
 struct Stem : Item {
-/*
-    /// rhythmical length
-    Moment note_length;
-    */  
-    // heads the stem encompasses (positions)
+    /// heads that the stem encompasses (positions)
     int minnote, maxnote;
 
     /// false if in beam
@@ -38,8 +34,8 @@ struct Stem : Item {
     /// needed for determining direction/length
     int staff_center;
 
-    // extent of the stem (positions)
-    /**
+
+    /**extent of the stem (positions).
       fractional, since Beam has to adapt them.
       */
 
@@ -49,8 +45,9 @@ struct Stem : Item {
     /// flagtype? 4 none, 8 8th flag, 0 = beam.
     int flag;
 
-    ///geen gedonder, jij gaat onder
+
     /**
+      geen gedonder, jij gaat onder.
        -1 stem points down, +1: stem points up
        */
 
diff --git a/hdr/tex.hh b/hdr/tex.hh
index baff1c634d..af45ba7d27 100644
--- a/hdr/tex.hh
+++ b/hdr/tex.hh
@@ -5,8 +5,7 @@
 #include "boxes.hh"
 #include "scalar.hh"
 
-/// parameter substitution in TeXstrings
-/**
+/** parameter substitution in TeXstrings.
   this function provides a simple macro mechanism:
 
   if source == "tex%bla%", then
diff --git a/hdr/textspanner.hh b/hdr/textspanner.hh
index 40ae5ffa64..586d25a5d8 100644
--- a/hdr/textspanner.hh
+++ b/hdr/textspanner.hh
@@ -11,10 +11,8 @@
 #include "directionalspanner.hh"
 #include "textdef.hh"
 
-/// a spanner which puts texts on top of other spanners.
-/**
-  Use for triplets, eentweetjes, ottava, etc.
-  */
+/** a spanner which puts texts on top of other spanners.  Use for
+  triplets, eentweetjes, ottava, etc.  */
 struct Text_spanner : Spanner {
     Text_def spec;
     Offset text_off_;
diff --git a/hdr/tstream.hh b/hdr/tstream.hh
index 27ec95cd16..4d5805c556 100644
--- a/hdr/tstream.hh
+++ b/hdr/tstream.hh
@@ -4,8 +4,8 @@
 #include <iostream.h>
 #include "string.hh"
 
-/// TeX output
-/**
+
+/** TeX output.
   Use this class for writing to a TeX file.
   It counts braces to prevent nesting errors, and
   it will add a comment sign before each newline.
diff --git a/hdr/voice.hh b/hdr/voice.hh
index 20538ae861..4d282ddea1 100644
--- a/hdr/voice.hh
+++ b/hdr/voice.hh
@@ -5,8 +5,7 @@
 #include "plist.hh"
 #include "moment.hh"
 
-/// class for  horizontal stuff.
-/**
+/** class for  horizontal stuff.
 
     Voice is a ordered row of Voice_elements. It is strictly horizontal:
     you cannot have two rhythmic elements running parallel in a Voice
@@ -26,12 +25,12 @@ struct Voice {
     void print() const;
     void set_default_group(String id);
 };
-/// one horizontal bit. 
-/** Apart from being a container for the requests, Voice_element is nothing
+
+/** one horizontal bit.  Apart from being a container for the requests, Voice_element is nothing
     */
 struct Voice_element {
     Moment duration;
-    char const* defined_ch_c_l_m;
+    char const* defined_ch_c_l_;
     const Voice *voice_l_;
     IPointerList<Request*> reqs;