Skip to content

Commit

Permalink
Merge pull request #2125 from nathan-contino/doxyfix
Browse files Browse the repository at this point in the history
Cherry-pick documentation fix into doxyfix branch
  • Loading branch information
lurch authored Dec 5, 2024
2 parents 60c6786 + 895778e commit e009cf5
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 3 deletions.
2 changes: 1 addition & 1 deletion src/common/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
This directory code that is common to all builds regardless of `PICO_PLATFORM`. It is a mix
of common header files, or high level functionality built entirely using `hardware_` or `pico_` libraries provided
by the actual target `PICO_PLATFORM``
by the actual target `PICO_PLATFORM`
4 changes: 2 additions & 2 deletions src/rp2_common/pico_standard_binary_info/doc.h
Original file line number Diff line number Diff line change
Expand Up @@ -9,11 +9,11 @@
* * The program name if defined (unless `PICO_NO_BINARY_SIZE=1`). The value is `PICO_PROGRAM_NAME` or `PICO_TARGET_NAME` if the former isn't defined
* * The value of PICO_BOARD (unless `PICO_NO_BI_PICO_BOARD=1`)
* * The SDK version (unless `PICO_NO_BI_SDK_VERSION=1`)
* * The program version string if defined (unless `PICO_NO_BI_PROGRAM_VERSION_STRING=1`). The value is `PICO_PROGRAM_VERSION_STRING``
* * The program version string if defined (unless `PICO_NO_BI_PROGRAM_VERSION_STRING=1`). The value is `PICO_PROGRAM_VERSION_STRING`
* * The program description if defined (unless `PICO_NO_BI_PROGRAM_DESCRIPTION=1`). The value is `PICO_PROGRAM_DESCRIPTION`
* * The program url if defined (unless `PICO_NO_BI_PROGRAM_URL=1`). The value is `PICO_PROGRAM_URL`
* * The boot stage 2 used if any (unless `PICO_NO_BI_BOOT_STAGE2_NAME=1`). The value is `PICO_BOOT_STAGE2_NAME`
* * The program build date (unless `PICO_NO_BI_PROGRAM_BUILD_DATE=1). The value defaults to the C preprocessor value `__DATE__`, but can be overridden with `PICO_PROGRAM_BUILD_DATE`. Note you should do a clean build if you want to be sure this value is up to date.
* * The program build date (unless `PICO_NO_BI_PROGRAM_BUILD_DATE=1`). The value defaults to the C preprocessor value `__DATE__`, but can be overridden with `PICO_PROGRAM_BUILD_DATE`. Note you should do a clean build if you want to be sure this value is up to date.
* * The program build type (unless `PICO_NO_BI_BUILD_TYPE=1`). The value is `PICO_CMAKE_BUILD_TYPE` which comes from the CMake build - e.g. Release, Debug, RelMinSize
* * The binary size (unless `PICO_NO_BI_BINARY_SIZE=1`)
*/

0 comments on commit e009cf5

Please sign in to comment.