From: fred Date: Fri, 14 Feb 1997 22:29:38 +0000 (+0000) Subject: flower-1.0.27 X-Git-Tag: release/1.5.59~6338 X-Git-Url: https://git.donarmstrong.com/?a=commitdiff_plain;h=0fd00126fdd46dc629fbcdf4d94163c1f87fd0b1;p=lilypond.git flower-1.0.27 --- diff --git a/flower/Makefile b/flower/Makefile index 9c69264115..611691fae6 100644 --- a/flower/Makefile +++ b/flower/Makefile @@ -19,7 +19,6 @@ fversion.hh: Variables.make make_version .PHONY: docxx docxx: $(hh) $(cc) $(templatecc) $(inl) - -mkdir docxx doc++ -p -d docxx $(hh) $(cc) $(templatecc) $(inl) dist: diff --git a/flower/assoc.hh b/flower/assoc.hh index 154a0242a2..07afb8a27c 100644 --- a/flower/assoc.hh +++ b/flower/assoc.hh @@ -11,8 +11,8 @@ struct Assoc_ent_ { V val; }; -/// hungarian: map -/** mindblowingly stupid Associative array implementation + +/** mindblowingly stupid Associative array implementation.Hungarian: map */ template struct Assoc { diff --git a/flower/compare.hh b/flower/compare.hh index 30a1998ad3..203ba014e7 100644 --- a/flower/compare.hh +++ b/flower/compare.hh @@ -28,8 +28,7 @@ operator op(type t1, type t2)\ #define gpp_minmax(type, prefix) #endif -/// handy notations for a signed comparison -/** +/** handy notations for a signed comparison. make the operators{<,<=,==,>=,>} and the MAX and MIN of two. Please fill a & in the type argument if necessary. */ diff --git a/flower/cursor.hh b/flower/cursor.hh index d8274d2493..0ea99037f9 100644 --- a/flower/cursor.hh +++ b/flower/cursor.hh @@ -6,8 +6,7 @@ #include "link.hh" template class List; -/// iterator to List -/** +/** iterator to List. add and insert extend the list items are always stored as copies in List, but: List : copies of String stored @@ -19,8 +18,8 @@ template class Cursor { public: - /** this isn't true, actually, #list# surely isn't const, but I get - tired of the warning messages. */ + /** create cursor, set at top. The const part isn't true, actually, #list# + surely isn't const, but I get tired of the warning messages. */ Cursor( const List& list, Link* pointer = 0 ); Cursor( const Cursor& cursor ); @@ -56,8 +55,7 @@ class Cursor /// -- items left? bool backward(); - /// put (copy) after me in List - /** + /** put (copy) after me in List. analogously to editor. ok() interpreted as at end of line. @@ -70,8 +68,7 @@ class Cursor */ void add( const T& thing ); - /// put (copy) before me in List - /** + /** put (copy) before me in List. analogously to editor. ok() interpreted as at begin of line. diff --git a/flower/dataf.cc b/flower/dataf.cc index e3c42ad45f..29b366c860 100644 --- a/flower/dataf.cc +++ b/flower/dataf.cc @@ -78,8 +78,7 @@ Data_file::get_word() return s; } -/// get a char. -/** +/** get a char Only class member who uses text_file::get */ char diff --git a/flower/list.hh b/flower/list.hh index 4f3c1aa825..ec59fbff07 100644 --- a/flower/list.hh +++ b/flower/list.hh @@ -5,9 +5,8 @@ class ostream; template class Cursor; template class Link; -/// all-purpose doubly linked list -/** - a doubly linked list; +/** all-purpose doubly linked list. + List can be seen as all items written down on paper, from top to bottom @@ -39,7 +38,7 @@ class List int size() const; - Cursor bottom() const; // const sucks.. + Cursor bottom() const; // const sucks. Cursor top() const; void OK() const; // check list @@ -50,8 +49,7 @@ class List void concatenate(List const &s); - /// make *this empty - /** + /** make *this empty. POST: size == 0 @@ -61,12 +59,12 @@ class List */ void set_empty(); - /// add after after_me void add( const T& thing, Cursor &after_me ); /// put thing before #before_me# void insert( const T& thing, Cursor &before_me ); - /** Remove link pointed to by me. Destructor of contents called + + /** Remove link pointed to by me. Destructor of contents called (nop for pointers) POST diff --git a/flower/list.tcc b/flower/list.tcc index 37ded81bbe..16e12a31f1 100644 --- a/flower/list.tcc +++ b/flower/list.tcc @@ -43,6 +43,18 @@ List::~List() c.del(); } +/** + + add after after_me. + + Procedure: + \begin{itemize} + \item if #after_me# is #ok()#, add after #after_me#, else + \item if list !empty simply add to bottom, else + \item list is empty: create first \Ref{Link} and initialize + #bottom_# and #top_#. + \end{itemize} +*/ template void List::add( const T& thing, Cursor &after_me ) @@ -62,16 +74,6 @@ List::add( const T& thing, Cursor &after_me ) size_++; } -/** - - Procedure: - \begin{itemize} - \item if #after_me# is #ok()#, add after #after_me#, else - \item if list !empty simply add to bottom, else - \item list is empty: create first \Ref{Link} and initialize - #bottom_# and #top_#. - \end{itemize} -*/ template void diff --git a/flower/path.hh b/flower/path.hh index 4a36730dcd..bc4d9f3776 100644 --- a/flower/path.hh +++ b/flower/path.hh @@ -4,8 +4,7 @@ #include "varray.hh" -/// searching directory for file. -/** +/** searching directory for file. Abstraction of PATH variable. An interface for searching input files. Search a number of dirs for a file. diff --git a/flower/plist.hh b/flower/plist.hh index 61b51d97e3..426b861c02 100644 --- a/flower/plist.hh +++ b/flower/plist.hh @@ -9,12 +9,15 @@ #include "list.hh" -/// Use for list of pointers, e.g. PointerList. /** + A list of pointers. + + Use for list of pointers, e.g. PointerList. This class does no deletion of the pointers, but it knows how to copy itself (shallow copy). We could have derived it from List, but this design saves a lot of code dup; for all PointerLists in the - program only one parent List is instantiated. */ + program only one parent List is instantiated. + */ template class PointerList : public List { @@ -30,8 +33,7 @@ class PointerList : public List PointerList() {} }; -/// pl. which deletes pointers given to it. -/** +/** PointerList which deletes pointers given to it. NOTE: The copy constructor doesn't do what you'd want: @@ -43,7 +45,8 @@ class PointerList : public List */ template -struct IPointerList : public PointerList { +class IPointerList : public PointerList { +public: IPointerList(const IPointerList&) { set_empty(); } IPointerList() { } ~IPointerList(); diff --git a/flower/string.cc b/flower/string.cc index eb5822cf32..9c7f2d0801 100644 --- a/flower/string.cc +++ b/flower/string.cc @@ -1,11 +1,12 @@ -/**************************************************************************** +/* PROJECT: FlowerSoft C++ library FILE : string.cc Rehacked by HWN 3/nov/95 removed String & introduced Class String_handle ---*/ + +*/ #include #include diff --git a/flower/string.hh b/flower/string.hh index e58f614699..420d5f959d 100644 --- a/flower/string.hh +++ b/flower/string.hh @@ -19,8 +19,7 @@ #include "stringutil.hh" -/// the smart string class. -/** +/** the smart string class. Intuitive string class. provides @@ -50,8 +49,7 @@ protected: String_handle data; // should derive String from String_handle? public: - /// init to "" - /** needed because other constructors are provided.*/ + /** init to "". needed because other constructors are provided.*/ String() { } String(Rational); /// String s = "abc"; @@ -118,8 +116,7 @@ public: /// index of rightmost element of string int lastPos( const char* string ) const; - /// index of leftmost c - /** + /** index of leftmost c. RETURN: 0 if not found, else index + 1 */ diff --git a/flower/textstr.hh b/flower/textstr.hh index 489682effd..2d648d4c19 100644 --- a/flower/textstr.hh +++ b/flower/textstr.hh @@ -7,8 +7,7 @@ #include "string.hh" #include "varray.hh" -/// line counting input stream. -/** +/** line counting input stream. a stream for textfiles. linecounting. Thin interface getchar and ungetchar. (ungetc is unlimited) diff --git a/flower/varray.hh b/flower/varray.hh index 0daafb84f8..d2c2f55321 100644 --- a/flower/varray.hh +++ b/flower/varray.hh @@ -15,9 +15,9 @@ inline void arrcpy(T*dest, T*src, int count) { *dest++ = *src++; } -///scaleable array/stack template, for T with def ctor. -/** +/** + scaleable array/stack template, for T with def ctor. This template implements a scaleable vector. With (or without) range checking. It may be flaky for objects with complicated con- and destructors. The type T should have a default constructor. It is @@ -52,8 +52,9 @@ public: assert(max >= size_ && size_ >=0); if (max) assert(thearray); } - /// report the size_. See {setsize_} - + /** report the size_. + @see {setsize_} + */ int size() const { return size_; } /// POST: size() == 0 @@ -61,13 +62,14 @@ public: Array() { thearray = 0; max =0; size_ =0; } - /// set the size_ to #s# + + /** set the size_ to #s#. + POST: size() == s. + Warning: contents are unspecified */ void set_size(int s) { if (s >= max) remax(s); size_ = s; } - /** POST: size() == s. - Warning: contents are unspecified */ ~Array() { delete[] thearray; } diff --git a/flower/vector.hh b/flower/vector.hh index 266254dbb8..4d91397cc6 100644 --- a/flower/vector.hh +++ b/flower/vector.hh @@ -9,8 +9,7 @@ class Dstream; class String; void set_matrix_debug(Dstream&ds); -/// a row of numbers -/** +/** a row of numbers. a vector. Storage is handled in Array, Vector only does the mathematics. */ class Vector {