Add Doxygen for the pico_binary_info macros #3077

New issue

Open

opened 2026-07-15 19:51:58 -05:00 by lurch · 2 comments

lurch commented 2026-07-15 19:51:58 -05:00 (Migrated from github.com)

• Copy link
• Copy Markdown

Currently we have Doxygen documentation for the pico_binary_info structs (e.g. see https://www.raspberrypi.com/documentation/pico-sdk/runtime.html#group_pico_binary_info ), but at https://github.com/raspberrypi/picotool/pull/342#discussion_r3589204244 @will-v-pi says that it'd be more useful to document the macros, rather than documenting the structs.

Currently we have Doxygen documentation for the pico_binary_info structs (e.g. see https://www.raspberrypi.com/documentation/pico-sdk/runtime.html#group_pico_binary_info ), but at https://github.com/raspberrypi/picotool/pull/342#discussion_r3589204244 @will-v-pi says that it'd be more useful to document the macros, rather than documenting the structs.

will-v-pi commented 2026-07-16 02:34:32 -05:00 (Migrated from github.com)

• Copy link
• Copy Markdown

This should probably be a pico-sdk issue, as that is where the macros/structs are defined

This should probably be a pico-sdk issue, as that is where the macros/structs are defined

lurch commented 2026-07-16 12:50:44 -05:00 (Migrated from github.com)

• Copy link
• Copy Markdown

This should probably be a pico-sdk issue, as that is where the macros/structs are defined

Doh!! That's obviously what I meant to do (and what I thought I'd done) - I must have been tired when creating the issue 😉

> This should probably be a pico-sdk issue, as that is where the macros/structs are defined Doh!! That's obviously what I meant to do (and what I thought I'd done) - I must have been tired when creating the issue 😉

Sign in to join this conversation.

No Branch/Tag specified

Branches Tags

master

rpi-connect-preview

ns-alpha

combine-uf2s

powman-fixups

persistent-data-docs

develop

aon-docs-fix

default-uart-fixups

async-context-deinit-freertos

sdk-time-critical

riscv-flag-check

multi-gcc-riscv-scrict-align

multi-gcc-develop

another-sleep-fix

powman-default-tick

bootrom_sysinfo_tweaks

board_header_checks

mbedtls-file-lists

use_count_of

vtable-per-core

stdio-usb-reset-compat

pico-aes

better-package

ditch_pico_pio_version

ns-develop

hardware-header-updates

low-power-ci

pioasm-cflags

lurch-patch-4

lurch-patch-3

rom_version

iar/develop

2.3.1

2.3.0

2.2.0

2.1.0-correct-picotool

2.1.1-correct-picotool

2.1.1

2.1.0

2.0.0

1.5.1

1.5.0

1.4.0

1.3.1

1.3.0

1.2.0

1.1.2

1.1.1

1.1.0

1.0.1

1.0.0

Labels

Clear labels   

bazel

  

bluetooth

  

board settings

  

boot_stage2

  

bug

Something isn't working

  

build

  

c++

  

can't reproduce

Can not reproduce the bug

  

clang

  

clib-interface

  

cmsis

  

code cleanliness

  

code size

  

compiler version issues

  

cyw43_driver

  

debug

  

discussion

  

documentation

Improvements or additions to documentation

  

duplicate

This issue or pull request already exists

  

dynamic_clock

  

elf2uf2

  

enhancement

New feature or request

  

errata

  

filesystem

  

flash layout

  

floating point

  

FreeRTOS

  

hardware_adc

  

hardware_claim

  

hardware_clocks

  

hardware_dma

  

hardware_exception

  

hardware_flash

  

hardware_gpio

  

hardware_i2c

  

hardware_irq

  

hardware_pio

  

hardware_pwm

  

hardware_rcp

  

hardware_rtc

  

hardware_spi

  

hardware_sync

  

hardware_uart

  

hardware_vreg

  

hardware_watchdog

  

hardware_xosc

  

help wanted

Extra attention is needed

  

host

  

IAR

  

installation

  

invalid

This doesn't seem right

  

linker scripts

  

lto

  

lwip

  

mbedtls

  

missing API

  

needs reporter detail

  

networking

  

newlib

  

newlib-multicore

  

non-c

  

non-cmake

  

non-gcc

  

openocd

  

orphan PR

  

OS integration

  

pico_async_context

  

pico_base

  

pico_binary_info

  

pico_flash

  

picolibc

  

pico_lwip

  

pico_malloc

  

pico_multicore

  

pico_printf

  

pico_runtime

  

pico_stdio

  

pico_stdio_usb

  

pico_sync

  

pico_time

  

pico_util

  

pioasm

  

port

issues or discussions of porting code/libraries to rp2040

  

question

Further information is requested

  

review

  

review2

  

rtos interop

Consideration for FreeRTOS co-existence

  

runtime init

  

static library

  

svd

  

test

  

tinyusb

  

vscode

  

wifi integration

  

wontfix

This will not be worked on

No labels

bazel

bluetooth

board settings

boot_stage2

bug

build

c++

can't reproduce

clang

clib-interface

cmsis

code cleanliness

code size

compiler version issues

cyw43_driver

debug

discussion

documentation

duplicate

dynamic_clock

elf2uf2

enhancement

errata

filesystem

flash layout

floating point

FreeRTOS

hardware_adc

hardware_claim

hardware_clocks

hardware_dma

hardware_exception

hardware_flash

hardware_gpio

hardware_i2c

hardware_irq

hardware_pio

hardware_pwm

hardware_rcp

hardware_rtc

hardware_spi

hardware_sync

hardware_uart

hardware_vreg

hardware_watchdog

hardware_xosc

help wanted

host

IAR

installation

invalid

linker scripts

lto

lwip

mbedtls

missing API

needs reporter detail

networking

newlib

newlib-multicore

non-c

non-cmake

non-gcc

openocd

orphan PR

OS integration

pico_async_context

pico_base

pico_binary_info

pico_flash

picolibc

pico_lwip

pico_malloc

pico_multicore

pico_printf

pico_runtime

pico_stdio

pico_stdio_usb

pico_sync

pico_time

pico_util

pioasm

port

question

review

review2

rtos interop

runtime init

static library

svd

test

tinyusb

vscode

wifi integration

wontfix

Milestone

Clear milestone

No items

No milestone

2.4.0

Assignees

Clear assignees

No assignees

1 participant

Notifications

Subscribe

Due date

The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set

Reference

gh-raspberrypi/pico-sdk#3077

No description provided.