comparison document/Document.h @ 127:fbd09fcda469

* doc updates

  * layers and their layout need to be stored and managed in much the
  * same way as changes to the underlying data.
  * 
  * The document manages:
  * 
- * -- A main data model, which provides the underlying sample rate and
- * such like.  This must be a wave file model.
+ *  - A main data Model, which provides the underlying sample rate and
+ * such like.  This must be a WaveFileModel.
  * 
- * -- Any number of imported models, which contain data without any
+ *  - Any number of imported Model objects, which contain data without any
  * requirement to remember where the data came from or how to
  * regenerate it.
  * 
- * -- Any number of models generated by transforms such as feature
- * extraction plugins.  For these, we also record the source model and
- * the name of the transform used to generate the model so that we can
- * regenerate it (potentially from a different source) on demand.
+ *  - Any number of Model objects that were generated by a Transform
+ * such as FeatureExtractionPluginTransform.  For these, we also
+ * record the source model and the name of the transform used to
+ * generate the model so that we can regenerate it (potentially
+ * from a different source) on demand.
  *
- * -- A flat list of layers.  Elsewhere, the GUI may distribute these
- * across any number of view widgets.  A layer may be viewable on more
+ *  - A flat list of Layer objects.  Elsewhere, the GUI may distribute these
+ * across any number of View widgets.  A layer may be viewable on more
  * than one view at once, in principle.  A layer refers to one model,
  * but the same model can be in use in more than one layer.
  *
  * The document does *not* manage the existence or structure of Pane
  * and other view widgets.  However, it does provide convenience