Permalink
Browse files

correct spelling

Signed-off-by: Stefan Nussbaumer <st9fan@gmail.com>
  • Loading branch information...
nuss committed Aug 25, 2013
1 parent 550a29d commit 6339f226c22afd447c0b5874c439ca490c45cffc
@@ -86,7 +86,7 @@ Put new link::Classes/CV::s into CVCenter
note::It shouldn't be necessary to initialize CVCenter with an explicit call to strong::*new::. Rather use strong::*use:: whenever possible as (strong::*use:: uses strong::*put:: internally)::
argument:: ... args
key/value pairs: code::\wdgtName1, a CV, \wdgtName2, (lo: a CV, hi: a CV), \wdgtNameN, a CV::
-If the number of arguments is odd and the last one is a link::Classes/Boolean:: this will indicate wether already contained values will be overwritten (default: code::false::)
+If the number of arguments is odd and the last one is a link::Classes/Boolean:: this will indicate whether already contained values will be overwritten (default: code::false::)
returns:: this (CVCenter)
@@ -669,4 +669,4 @@ Pdef(\hiHat,
)
Pdef(\hiHat).play(t);
-::
+::
@@ -29,7 +29,7 @@ ARGUMENT:: guiProperties
a link::Classes/Rect:: an link::Classes/Array:: providing code::left::, code::top::, code::width::, code::height:: - will be ignored if 'saveProperties is set to code::0:: or code::1::
ARGUMENT:: saveClassVars
-a link::Classes/Boolean::, or an link::Classes/Integer:: ( code::0:: or code::1::), indicating wether CVCenter's classvars link::Classes/CVCenter#*midiMode#midiMode::, link::Classes/CVCenter#*midiResolution#midiResolution::, link::Classes/CVCenter#*midiMean#midiMean::, link::Classes/CVCenter#*softWithin#softWithin::, link::Classes/CVCenter#*ctrlButtonBank#ctrlButtonBank::. All these classvars have equivalent instancevars in CVWidget that will overwrite CVCenter's classvars if set. Thus the user may set global values here and tweak them within each CVWidget created in CVCenter.
+a link::Classes/Boolean::, or an link::Classes/Integer:: ( code::0:: or code::1::), indicating whether CVCenter's classvars link::Classes/CVCenter#*midiMode#midiMode::, link::Classes/CVCenter#*midiResolution#midiResolution::, link::Classes/CVCenter#*midiMean#midiMean::, link::Classes/CVCenter#*softWithin#softWithin::, link::Classes/CVCenter#*ctrlButtonBank#ctrlButtonBank::. All these classvars have equivalent instancevars in CVWidget that will overwrite CVCenter's classvars if set. Thus the user may set global values here and tweak them within each CVWidget created in CVCenter.
If set to code::0:: the arguments code::midiMode::, code::midiResolution::, code::midiMean::, code::softWithin:: and code::ctrlButtonBank:: will be ignored.
ARGUMENT:: midiMode
@@ -51,7 +51,7 @@ ARGUMENT:: ctrlButtonBank
CVCenter was written with a Doepfer Pocket Dial in mind which provides 16 fader-knobs and 4 different banks which sums up to 64 different slider-slots. However, it is not obvious which slider has to be moved to trigger a CCResponder initialised for controller nr. 37. Setting this argument to 16 (the number of knobs) will display controller nr. 37 as 3:5 (knob number 5 in bank 3).
ARGUMENT:: removeResponders
-a link::Classes/Boolean::, or an link::Classes/Integer:: ( code::0:: or code::1::). This argument sets link::Classes/CVWidget#*removeResponders::, indicating wether MIDI- and OSC-responders shall be removed upon hitting Cmd/Ctrl-period. If it is set to code::0:: or code::false:: unreferenced ghost-responders are left that may be hard to remove.
+a link::Classes/Boolean::, or an link::Classes/Integer:: ( code::0:: or code::1::). This argument sets link::Classes/CVWidget#*removeResponders::, indicating whether MIDI- and OSC-responders shall be removed upon hitting Cmd/Ctrl-period. If it is set to code::0:: or code::false:: unreferenced ghost-responders are left that may be hard to remove.
ARGUMENT:: informString
a link::Classes/String::, used as alternative inform-message (optional)
@@ -64,4 +64,4 @@ Reads the above set values.
ARGUMENT:: ... args
if no arguments are set all values in the current preferences are returened, otherwise those that have been requested (argument-names equal those used in writePreferences).
-returns:: an link::Classes/Event:: containing the current preferences if they exist.
+returns:: an link::Classes/Event:: containing the current preferences if they exist.
@@ -9,7 +9,7 @@ CVWidget is the abstract superclass of all CVWidgets (currently: link::Classes/C
CLASSMETHODS::
METHOD:: removeResponders
-A link::Classes/Boolean::, indicating wether MIDI- and OSC-responders shall be removed upon hitting Cmd/Ctrl-period. If it is set to code::false:: unreferenced ghost-responders are left that may be hard to remove.
+A link::Classes/Boolean::, indicating whether MIDI- and OSC-responders shall be removed upon hitting Cmd/Ctrl-period. If it is set to code::false:: unreferenced ghost-responders are left that may be hard to remove.
returns:: code::this:: (CVWidget)
@@ -30,8 +30,8 @@ METHOD:: setup
The current widget-setup, returned as an link::Classes/Event::. If the widget is a link::Classes/CVWidget2D:: each key of the returned Event will be split in a code::\lo:: and a code::\hi:: value:
definitionList::
## midiMode || as set by link::#-setMidiMode::. default: code::0::
- ## calibrate || indicates wether OSC-calibration is active or not, set by link::#-setCalibrate::. default: code::true::
- ## ctrlButtonBank || indicates wether the code::ctrlButtonBank:: parameter, reflecting a MIDI-device's bank-layout is set. This can be set with link::#-setCtrlButtonBank::. default: code::nil::
+ ## calibrate || indicates whether OSC-calibration is active or not, set by link::#-setCalibrate::. default: code::true::
+ ## ctrlButtonBank || indicates whether the code::ctrlButtonBank:: parameter, reflecting a MIDI-device's bank-layout is set. This can be set with link::#-setCtrlButtonBank::. default: code::nil::
## midiMean || if a MIDI-device is set to in-/decremental mode reps. code::midiMode:: is set to code::1:: this will be the mean output-value. Can be set with link::#-setMidiMean::. default: code::64::
## midiResolution || if code::midiMode:: is set to code::1:: the step-size of each slider is determined by this parameter. Can be set with link::#-setMidiResolution::. default: code::1::
## softWithin || if code::midiMode:: is set to code::0:: this determines the tolerance at which a MIDI-slider will respond when moved. For a more detailed explanation see link::#-setSoftWithin::. default: code::0.1::
@@ -150,7 +150,7 @@ METHOD:: setCalibrate
Unlike MIDI the range of incoming OSC-values isn't 0-127 - it is unknown at the time of initialization of the OSC-responder. All CVWidgets have an inbuilt calibration mechanism that determines the range automatically. At initialization the range is set to [0.0001, 0.0001]. If the mechanism detects a value that is lower or higher than the values set at initialization it will set the constraints accordingly. This method allows to stop or start the calibration-process.
argument:: bool
-a link::Classes/Boolean::, indicating wether the calibration-process shall be started or stopped.
+a link::Classes/Boolean::, indicating whether the calibration-process shall be started or stopped.
argument:: slot
only needed if the widget is a link::Classes/CVWidget2D:: - either code::\lo:: or code::\hi::
@@ -304,7 +304,7 @@ argument:: slot
only needed if the widget is a link::Classes/CVWidget2D:: - either code::\lo:: or code::\hi::
argument:: active
-a link::Classes/Boolean::, indicating wether the action shall become active immediatly
+a link::Classes/Boolean::, indicating whether the action shall become active immediatly
returns:: the receiver
@@ -326,7 +326,7 @@ argument:: name
a link::Classes/Symbol:: or a link::Classes/String::, representing the action's name
argument:: activate
-a link::Classes/Boolean::, indicating wether the action shall be activated or deactivated
+a link::Classes/Boolean::, indicating whether the action shall be activated or deactivated
argument:: slot
only needed if the widget is a link::Classes/CVWidget2D:: - either code::\lo:: or code::\hi::
@@ -742,4 +742,4 @@ Server.default.waitForBoot{ ~noise = { SinOsc.ar(\freq.kr([0, 0]), mul: \amp.kr)
// actions, responders etc. of the old one
~knob = ~knob.open;
~twoDee = ~twoDee.open;
-::
+::

0 comments on commit 6339f22

Please sign in to comment.