From: nishi <nishi@7b47e76f-e598-2f43-bc14-414d160cc389>
Date: Sun, 7 Apr 2024 10:57:09 +0000 (+0000)
Subject: fix doxygen op
X-Git-Url: http://10.10.0.4:5575/?a=commitdiff_plain;h=0dbba5553c638ff55b44ad01d75b5ab906332396;p=ksynth.git

fix doxygen op

git-svn-id: file:///raid/svn-main/kazu-ksynth/trunk@14 7b47e76f-e598-2f43-bc14-414d160cc389
---

diff --git a/src/ksynth.h b/src/ksynth.h
index b66da32..38a5db3 100644
--- a/src/ksynth.h
+++ b/src/ksynth.h
@@ -33,7 +33,7 @@ struct KSynth {
  * @param sample_rate Sample rate
  * @param num_channel Number of channels (1-2)
  * @param max_polyphony Maximum polyphony (1-100,000)
- * @return struct KSynth* A pointer to the newly created KSynth instance on success, NULL on failure.
+ * @return A pointer to the newly created KSynth instance on success, NULL on failure.
  */
 struct KSynth* ksynth_new(const char* sample_file_path, int sample_rate, int num_channel, int max_polyphony);
 
@@ -68,7 +68,7 @@ void ksynth_note_off_all(struct KSynth* ksynth_instance);
  * @brief Gets the current polyphony.
  *
  * @param ksynth_instance Pointer to the KSynth instance
- * @return int The current polyphony
+ * @return The current polyphony
  */
 int ksynth_get_polyphony(struct KSynth* ksynth_instance);
 
@@ -76,17 +76,17 @@ int ksynth_get_polyphony(struct KSynth* ksynth_instance);
  * @brief Gets the maximum polyphony.
  *
  * @param ksynth_instance Pointer to the KSynth instance
- * @return int The maximum polyphony
+ * @return The maximum polyphony
  */
 int ksynth_get_max_polyphony(struct KSynth* ksynth_instance);
 
 /**
  * @brief Sets the maximum polyphony.
- * DO NOT CALL THIS FUNCTION. IT IS NOT WORKING NOW (IT IS RETURNINNG ALWAYS FALSE).
+ * @warning DO NOT CALL THIS FUNCTION. IT IS NOT WORKING NOW (IT IS RETURNINNG ALWAYS FALSE).
  *
  * @param ksynth_instance Pointer to the KSynth instance
  * @param max_polyphony Maximum polyphony (Note: Values exceeding 100,000 will be clamped)
- * @return bool Returns true on success, false on failure.
+ * @return Returns true on success, false on failure.
  */
 bool ksynth_set_max_polyphony(struct KSynth* ksynth_instance, int max_polyphony);
 
@@ -101,7 +101,7 @@ bool ksynth_set_max_polyphony(struct KSynth* ksynth_instance, int max_polyphony)
  *
  * @param ksynth_instance Pointer to the KSynth instance
  * @param buffer_size Size of the buffer (Note: Values are typically between 32 and 16384)
- * @return float* A pointer to the generated buffer on success, NULL on failure.
+ * @return A pointer to the generated buffer on success, NULL on failure.
  */
 float* ksynth_generate_buffer(struct KSynth* ksynth_instance, int buffer_size);
 
@@ -113,7 +113,7 @@ float* ksynth_generate_buffer(struct KSynth* ksynth_instance, int buffer_size);
  * and any longer processing time may result in buffer underrun, leading to audio glitches or gaps.
  *
  * @param ksynth_instance Pointer to the KSynth instance
- * @return float Rendering time as a percentage of the buffer duration (0 to 100%)
+ * @return Rendering time as a percentage of the buffer duration (0 to 100%)
  */
 float ksynth_get_rendering_time(struct KSynth* ksynth_instance);
 
@@ -122,7 +122,7 @@ float ksynth_get_rendering_time(struct KSynth* ksynth_instance);
  *
  * @param ksynth_instance Pointer to the KSynth instance
  * @param channel MIDI channel
- * @return int Number of active polyphony for the specified MIDI channel
+ * @return Number of active polyphony for the specified MIDI channel
  */
 int ksynth_get_polyphony_for_channel(struct KSynth* ksynth_instance, int channel);