Skip to content
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

If there are no global instances defined, don't provide default &Seri… #112

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

fionn-r
Copy link

@fionn-r fionn-r commented Feb 1, 2023

This is a fix to issue #111 where if HardwareSerial Serial is not defined, Adafruit_BusIO_Register.h will not be able to find Serial and cause compilation to fail.

The change only affects the scope where either NO_GLOBAL_INSTANCES or NO_GLOBAL_SERIAL is defined, which is the case where it was failing to compile anyway. In all other cases, the change has no impact. If a dependent is requiring the default argument, then the dependent will not compile anyway if there is no global serial.

@fionn-r
Copy link
Author

fionn-r commented Feb 1, 2023

That error looks like there's more an issue with how the doxygen docs generation is done rather than the change....

Is there an easy fix to this? I can add docs to the .h file but that goes against the documentation at definition rather than declaration. I can also add a doxygen \cond wrapper around in the header?

@ladyada
Copy link
Member

ladyada commented Aug 13, 2023

yah you can add \cond or otherwise make doxygen tweaks but we do require doxygen passes to merge :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants