preferences: add description to preferences and autogenerate the docs #1869
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
Contributor
AlexandraTrifan
commented
Dec 20, 2024
•
AlexandraTrifan
commented
- Added an info button to display extra details in each preference.
- Create preferences using a macro.
- Scan for the macro when generating documentation and automatically populate it.
- Screenshots on how this looks like: doc_resources: add Scopy preferences screenshots #1884
All the preferences now require a description and are created using function macros in order to parse and automatically detect all. Signed-off-by: AlexandraTrifan <[email protected]>
AlexandraTrifan
force-pushed
the
main-doc-prefs
branch
from
28d6b42 to
745ddaa
Compare
Signed-off-by: AlexandraTrifan <[email protected]>
AlexandraTrifan
force-pushed
the
main-doc-prefs
branch
from
745ddaa to
20bdea7
Compare
AlexandraTrifan
changed the title
AlexandraTrifan
requested review from
andrei47w,
adisuciu,
andreidanila1,
Andrei-Fabian-Pop,
IonutMuthi and
bindea-cristian
AlexandraTrifan
changed the title
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.