Skip to content

Make header file compatible with doxygen #6

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Sep 1, 2023
Merged

Conversation

sebromero
Copy link
Contributor

@sebromero sebromero commented Aug 31, 2023

Without the double asterisk and the @file declaration, doxygen won't render any documentation for global functions. This PR fixes this.

@sebromero sebromero requested a review from alrvid August 31, 2023 22:20
@sebromero sebromero force-pushed the doxygen-compatibility branch from 64369cb to e1f858a Compare August 31, 2023 22:22
@github-actions
Copy link

Memory usage change @ 64369cb

Board flash % RAM for global variables %
arduino:mbed_portenta:envie_m7 N/A N/A N/A N/A
arduino:renesas_portenta:portenta_c33 0 - 0 0.0 - 0.0 0 - 0 0.0 - 0.0
Click for full report table
Board examples/SD_Card_Example
flash
% examples/SD_Card_Example
RAM for global variables
% examples/USB_Hotplug_Example
flash
% examples/USB_Hotplug_Example
RAM for global variables
% examples/USB_No_Hotplug_Example
flash
% examples/USB_No_Hotplug_Example
RAM for global variables
% examples/tests/Arduino_POSIXStorage_Test
flash
% examples/tests/Arduino_POSIXStorage_Test
RAM for global variables
%
arduino:mbed_portenta:envie_m7 N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A
arduino:renesas_portenta:portenta_c33 0 0.0 0 0.0 0 0.0 0 0.0 0 0.0 0 0.0 0 0.0 0 0.0
Click for full report CSV
Board,examples/SD_Card_Example<br>flash,%,examples/SD_Card_Example<br>RAM for global variables,%,examples/USB_Hotplug_Example<br>flash,%,examples/USB_Hotplug_Example<br>RAM for global variables,%,examples/USB_No_Hotplug_Example<br>flash,%,examples/USB_No_Hotplug_Example<br>RAM for global variables,%,examples/tests/Arduino_POSIXStorage_Test<br>flash,%,examples/tests/Arduino_POSIXStorage_Test<br>RAM for global variables,%
arduino:mbed_portenta:envie_m7,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A
arduino:renesas_portenta:portenta_c33,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0

@github-actions
Copy link

Memory usage change @ e1f858a

Board flash % RAM for global variables %
arduino:mbed_portenta:envie_m7 N/A N/A N/A N/A
arduino:renesas_portenta:portenta_c33 0 - 0 0.0 - 0.0 0 - 0 0.0 - 0.0
Click for full report table
Board examples/SD_Card_Example
flash
% examples/SD_Card_Example
RAM for global variables
% examples/USB_Hotplug_Example
flash
% examples/USB_Hotplug_Example
RAM for global variables
% examples/USB_No_Hotplug_Example
flash
% examples/USB_No_Hotplug_Example
RAM for global variables
% examples/tests/Arduino_POSIXStorage_Test
flash
% examples/tests/Arduino_POSIXStorage_Test
RAM for global variables
%
arduino:mbed_portenta:envie_m7 N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A
arduino:renesas_portenta:portenta_c33 0 0.0 0 0.0 0 0.0 0 0.0 0 0.0 0 0.0 0 0.0 0 0.0
Click for full report CSV
Board,examples/SD_Card_Example<br>flash,%,examples/SD_Card_Example<br>RAM for global variables,%,examples/USB_Hotplug_Example<br>flash,%,examples/USB_Hotplug_Example<br>RAM for global variables,%,examples/USB_No_Hotplug_Example<br>flash,%,examples/USB_No_Hotplug_Example<br>RAM for global variables,%,examples/tests/Arduino_POSIXStorage_Test<br>flash,%,examples/tests/Arduino_POSIXStorage_Test<br>RAM for global variables,%
arduino:mbed_portenta:envie_m7,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A
arduino:renesas_portenta:portenta_c33,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0

@alrvid alrvid merged commit 3f4cdca into main Sep 1, 2023
@per1234 per1234 added type: imperfection Perceived defect in any part of project topic: documentation Related to documentation for the project labels Sep 1, 2023
@sebromero sebromero deleted the doxygen-compatibility branch September 4, 2023 08:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
topic: documentation Related to documentation for the project type: imperfection Perceived defect in any part of project
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants