Small doxygen tweaks #3038

2026-06-27T17:45:42-05:00

lurch commented

2026-06-27 17:45:42 -05:00

(Migrated from github.com)

Small followup to #3022

will-v-pi (Migrated from github.com) reviewed

2026-06-28 04:44:57 -05:00

will-v-pi (Migrated from github.com) reviewed

2026-06-28 04:46:39 -05:00

src/common/pico_binary_info/include/pico/binary_info/structure.h

					
				@ -158,3 +158,3 @@

				/*! \brief Binary info entry describing one or more GPIO pins and their assigned function

				/*! \brief Binary info entry describing one or more GPIO pins and their assigned function, supporting pin numbers <32, and up to 5 pins

				 *  \ingroup pico_binary_info

				 */

/*! \brief Binary info entry describing one or more GPIO pins and their assigned function, supporting pin numbers <256, and up to 7 pins

```suggestion /*! \brief Binary info entry describing one or more GPIO pins and their assigned function, supporting pin numbers <256, and up to 7 pins ```

kilograham (Migrated from github.com) reviewed

2026-06-28 14:28:54 -05:00

src/rp2_common/hardware_interp/include/hardware/interp.h

					
				@ -355,2 +353,4 @@

				static inline void interp_set_base(interp_hw_t *interp, uint index, uint32_t val) {

				    interp->base[index] = val;

				}

i dont think you meant to change these lane -> index?

lurch (Migrated from github.com) reviewed

2026-06-28 17:15:13 -05:00

src/rp2_common/hardware_interp/include/hardware/interp.h

					
				@ -355,2 +353,4 @@

				static inline void interp_set_base(interp_hw_t *interp, uint index, uint32_t val) {

				    interp->base[index] = val;

				}

I deliberately changed this, because it was implying there's a "lane 2" which I think was confusing / misleading? Happy to accept any improved wording.

lurch (Migrated from github.com) reviewed

2026-06-28 17:19:52 -05:00

src/rp2_common/hardware_interp/include/hardware/interp.h

					
				@ -355,2 +353,4 @@

				static inline void interp_set_base(interp_hw_t *interp, uint index, uint32_t val) {

				    interp->base[index] = val;

				}

(Another approach I considered was to leave these as "Sets the interpolator base register by lane" but to restrict the lane parameter to just be 0 or 1, and then have a separate function for setting interp->base[2], but I dismissed that idea because it would be backwards-incompatible)

(Another approach I considered was to leave these as "Sets the interpolator base register by lane" but to restrict the `lane` parameter to just be `0` or `1`, and then have a separate function for setting `interp->base[2]`, but I dismissed that idea because it would be backwards-incompatible)

lurch (Migrated from github.com) reviewed

2026-06-28 17:33:06 -05:00

src/rp2_common/hardware_interp/include/hardware/interp.h

					
				@ -355,2 +353,4 @@

				static inline void interp_set_base(interp_hw_t *interp, uint index, uint32_t val) {

				    interp->base[index] = val;

				}

Just realised that I forgot to rename the lane parameters - now fixed. (The heat was making it hard for me to concentrate 🥵 )

Just realised that I forgot to rename the `lane` parameters - now fixed. (The heat was making it hard for me to concentrate :hot_face: )

will-v-pi (Migrated from github.com) approved these changes

2026-06-29 05:30:09 -05:00

will-v-pi (Migrated from github.com) left a comment

LGTM - I agree about changing the interpolator base register docs away from lane, as there are only 2 lanes, and index does seem like the simplest option

LGTM - I agree about changing the interpolator base register docs away from `lane`, as there are only 2 lanes, and `index` does seem like the simplest option

Sign in to join this conversation.

No reviewers

will-v-pi