Add support for QtSignals #401
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This change adds proper support for QtSignals by treating signals
as functions (similar to what has been done for QtSlots).
In addition change the example for QtSlots to QtSignalsAndSlots so
that both signals and slots are properly documented and validated.
Without this change breathe emits the following warnings for classes
that contain signals:
WARNING: Error in declarator or parameters and qualifiers
If pointer to member declarator:
Invalid definition: Expected identifier in nested name. [error at 34]
QtSignalSlotExample::workingSignal
----------------------------------^
breathe/renderer/sphinxrenderer.py:802:14: W605 invalid escape sequence '\[' breathe/renderer/sphinxrenderer.py:802:14: W605 invalid escape sequence '\]'
vermeeren
added
enhancement
|
Looks good to me, thanks. Should I bump version and release for this? |
vermeeren
added a commit
that referenced
this pull request
Oct 30, 2018
|
Thanks. A new release would be great, then I can start using it in my CI pipeline. |
|
Released v4.11.0 just now. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This change adds proper support for QtSignals by treating signals as functions (similar to what has been done for QtSlots in b584c32).
In addition change the example for QtSlots to QtSignalsAndSlots so that both signals and slots are properly documented and validated.
Without this change breathe emits the following warnings for classes
that contain signals: