Changeset a2952c in git

Timestamp:

Feb 10, 1998, 10:51:02 AM (26 years ago)

Author:

Jens Schmidt <schmidt@…>

Branches:

(u'spielwiese', '2fa36c576e6a4ddbb1093b43c7f8e9835e17e52a')

Children:

a31a46c44b0893d78ff72ccce3006d4282514d1f

Parents:

abc625ea7218c401cfe020a534d5f30c28d85f75

Message:

	* cf_switches.h: doc fix


git-svn-id: file:///usr/local/Singular/svn/trunk@1139 2c84dea3-7e68-4137-9b89-c4e89433aadc

File:

• factory/cf_switches.h (modified) (4 diffs)

factory/cf_switches.h

@@ -1 +1 @@
 /* emacs edit mode for this file is -*- C++ -*- */
-/* $Id: cf_switches.h,v 1.6 1998-01-16 18:08:44 schmidt Exp $ */
+/* $Id: cf_switches.h,v 1.7 1998-02-10 09:51:02 schmidt Exp $ */
 
 #ifndef INCL_CF_SWITCHES_H
@@ -27 +27 @@
 // class CFSwitches - manages boolean switches.
 //
-// An object of type CFSwitches is simply an array of booleans
-// with some comfortable access methods (On, Off).  Each object
-// may contain CFSwitchesMax switches.  When a new object of type
-// CFSwitches is created, all its switches are turned off.
+// An object of class `CFSwitches' is simply an array of booleans
+// with some comfortable access methods (`On()', `isOn()', etc.).
+// Each object may contain `CFSwitchesMax' switches.  When a new
+// object of type `CFSwitches' is created, all its switches are
+// turned off.
 //
 // Note: No range checking is done when accessing switches.
@@ -44 +45 @@
 // bool isOff ( int s ) const
 //
-// On(), Off() - switch s on or off, resp.
+// On(), Off() - switch `s' on or off, resp.
 //
-// isOn(), isOff() - return true iff s is on or off, resp.
+// isOn(), isOff() - return true iff `s' is on or off, resp.
 //
 //}}}
@@ -53 +54 @@
 private:
     bool switches [CFSwitchesMax];
+
 public:
+    // constructors, destructors
     CFSwitches ();
     ~CFSwitches () {}
 
+    // selectors
     void On ( int s ) { switches[s] = true; }
     void Off ( int s ) { switches[s] = false; }