docs: Unify NOTE style, fix doc in rdpq_texture_rectangle in IDEs

DragonMinded · Sep 9, 2024 · fb2569d · fb2569d
1 parent 4b10c08
commit fb2569d
Show file tree

Hide file tree

Showing 3 changed files with 11 additions and 10 deletions.
diff --git a/include/audio.h b/include/audio.h
@@ -52,12 +52,11 @@ extern "C" {
 /**
  * @brief Will be called periodically when more sample data is needed.
  *
- * @param[in] buffer
- *            The address to write the sample data to
- * @param[in] numsamples
- *            The number of samples to write to the buffer
- *            Note: this is the number of samples per channel, so clients
- *            should write twice this number of samples (interleaved).
+ * @param[in] buffer        The address to write the sample data to
+ * @param[in] numsamples    The number of samples to write to the buffer
+ * 
+ * NOTE: This is the number of samples per channel, so clients should write
+ * twice this number of samples (interleaved).
  */
 typedef void(*audio_fill_buffer_callback)(short *buffer, size_t numsamples);
 

diff --git a/include/rdpq_rect.h b/include/rdpq_rect.h
@@ -292,6 +292,9 @@ inline void __rdpq_texture_rectangle_flip_raw_fx(rdpq_tile_t tile, uint16_t x0,
  * call #rdpq_triangle instead, and thus draw the rectangles as two triangles.
  * This will however incur in more overhead on the CPU to setup the primitives.
  * 
+ * NOTE: implemented using a macro here to support both integer and float inputs
+ * without ever forcing a useless additional conversion.
+ * 
  * @param[in]   tile    Tile descriptor referring to the texture in TMEM to use for drawing
  * @param[in]   x0      Top-left X coordinate of the rectangle
  * @param[in]   y0      Top-left Y coordinate of the rectangle
@@ -302,8 +305,6 @@ inline void __rdpq_texture_rectangle_flip_raw_fx(rdpq_tile_t tile, uint16_t x0,
  * 
  * @hideinitializer
  */
-// NOTE: we use a macro here to support both integer and float inputs without ever forcing
-// a useless additional conversion.
 #define rdpq_texture_rectangle(tile, x0, y0, x1, y1, s, t) \
     __rdpq_texture_rectangle_fx((tile), (x0)*4, (y0)*4, (x1)*4, (y1)*4, (s)*32, (t)*32)
 

diff --git a/include/rdpq_tex.h b/include/rdpq_tex.h
@@ -216,7 +216,8 @@ void rdpq_tex_upload_tlut(uint16_t *tlut, int color_idx, int num_colors);
  * Starting vertical position t0 must be in multiples of 2 pixels due to TMEM arrangement.
  * 
  * Leaving parms to NULL will copy the previous' texture texparms.
- * Note: This function must be executed in a multi-upload block right after the reused texture has been
+ * 
+ * NOTE: This function must be executed in a multi-upload block right after the reused texture has been
  * uploaded.
  * 
  * @param tile       Tile descriptor that will be initialized with reused texture
@@ -239,7 +240,7 @@ int rdpq_tex_reuse_sub(rdpq_tile_t tile, const rdpq_texparms_t *parms, int s0, i
  * This full-variant will use the whole texture that was previously uploaded.
  * Leaving parms to NULL will copy the previous' texture texparms.
  * 
- * Note: This function must be executed in a multi-upload block right after the reused texture has been
+ * NOTE: This function must be executed in a multi-upload block right after the reused texture has been
  * uploaded.
  * 
  * @param tile       Tile descriptor that will be initialized with reused texture