Documentation fixes.
authorStefan Westerfeld <stefan@space.twc.de>
Thu, 8 Jul 2010 16:07:31 +0000 (18:07 +0200)
committerStefan Westerfeld <stefan@space.twc.de>
Thu, 8 Jul 2010 16:07:31 +0000 (18:07 +0200)
lib/smaudio.cc
lib/smencoder.cc
lib/smframe.cc

index 34446ac..63370d8 100644 (file)
@@ -31,6 +31,7 @@ using std::vector;
  * This function loads a SM-File.
  *
  * \param filename the name of the SM-File to be loaded
+ * \param load_options specify whether to load or skip debug information
  * \returns a BseErrorType indicating whether loading was successful
  */
 BseErrorType
@@ -165,7 +166,6 @@ SpectMorph::Audio::Audio() :
  * This function saves a SM-File.
  *
  * \param filename the name of the SM-File to be written
- * \param audio the audio object to be stored
  * \returns a BseErrorType indicating saving loading was successful
  */
 BseErrorType
index dc98dc1..2166b98 100644 (file)
@@ -836,6 +836,10 @@ Encoder::attack_error (const vector< vector<double> >& unscaled_signal, const ve
   return total_error;
 }
 
+/**
+ * This function computes the optimal attack parameters, by finding the optimal
+ * attack envelope (attack_start_ms and attack_end_ms) given the data.
+ */
 void
 Encoder::compute_attack_params (const vector<float>& window)
 {
@@ -926,6 +930,14 @@ Encoder::compute_attack_params (const vector<float>& window)
   optimal_attack = attack;
 }
 
+/**
+ * This function calls all steps necessary for encoding in the right order.
+ *
+ * \param dhandle a data handle containing the signal to be encoded
+ * \param window the analysis window
+ * \param optimization_level determines if fast (0), medium (1), or very slow (2) algorithm is used
+ * \param attack whether to find the optimal attack parameters
+ */
 void
 Encoder::encode (GslDataHandle *dhandle, const vector<float>& window, int optimization_level, bool attack)
 {
index 42d9daa..fad019b 100644 (file)
@@ -50,6 +50,10 @@ Frame::Frame (const SpectMorph::AudioBlock& audio_block, size_t frame_size) :
   decoded_sines.resize (frame_size);
 }
 
+/**
+ * computes the magnitude of a partial (complex abs)
+ * \param partial the partial (numbered in the same way as the freq index)
+ */
 double
 Frame::magnitude (size_t partial) const
 {