more documentation

[moosique.git] / MooInstrumentList.java

diff --git a/MooInstrumentList.java b/MooInstrumentList.java
index ed976dd4434d952c614a113bc77030980b2d6855..7138c374f2c2e0379eee9907eb5ea0cfa64e70a4 100644 (file)
--- a/MooInstrumentList.java
+++ b/MooInstrumentList.java
@@ -12,6 +12,11 @@ import java.awt.event.*;
 public class MooInstrumentList extends JComboBox implements ActionListener {
 
        protected int channel;
+       
+       /**
+        * Creates the instrument list.
+        * @param chan The channel it will operate on.
+        */
        public MooInstrumentList(int chan) {
                super(instruments);
                setChannel(chan);       
@@ -19,17 +24,26 @@ public class MooInstrumentList extends JComboBox implements ActionListener {
                addActionListener(this);
        }
 
-       public void setChannel(int chan){
+       /**
+        * Sets the channel that it will operate on.
+        */
+       public void setChannel(int chan) {
                channel = chan;
                setSelectedIndex(Moosique.getChannel(channel).getProgram());
        }
 
+       /**
+        * Sets the instrument on a channel when it's changed in the combobox.
+        */
        public void actionPerformed(ActionEvent e) {
                JComboBox box = (JComboBox)e.getSource();
                int instrument = box.getSelectedIndex();
                Moosique.getChannel(channel).programChange(instrument);
        }
     
+       /**
+        * The list with standard midi instruments.
+        */
        public static final String[] instruments = {
                " 0 Acoustic Grand Piano",
                " 1 Bright Acoustic Piano",