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.

Sign up for GitHub

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

Jump to bottom

preferences: add description to preferences and autogenerate the docs #1869

Merged
merged 2 commits into from
Feb 4, 2025
Merged

preferences: add description to preferences and autogenerate the docs #1869

merged 2 commits into from
Feb 4, 2025

Conversation

AlexandraTrifan
Copy link
Contributor

@AlexandraTrifan AlexandraTrifan commented Dec 20, 2024 •
edited
Loading

@AlexandraTrifan AlexandraTrifan marked this pull request as ready for review January 23, 2025 15:04
@AlexandraTrifan AlexandraTrifan changed the title wip: add description to preferences and try to autogenerate the docs preferences: add description to preferences and try to autogenerate the docs Jan 23, 2025
@AlexandraTrifan AlexandraTrifan changed the title preferences: add description to preferences and try to autogenerate the docs preferences: add description to preferences and autogenerate the docs Jan 23, 2025
bindea-cristian
bindea-cristian approved these changes Jan 29, 2025
View reviewed changes
Copy link
Contributor

@bindea-cristian bindea-cristian left a comment •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The text displayed by the info button can be hard to read if it's too long.
One way to improve readability would be to add in a few places an "\n".

@AlexandraTrifan
Copy link
Contributor Author

The text displayed by the info button can be hard to read if it's too long. One way to improve readability would be to add in a few places an "\n".

I tested with some \n, \r,
and none works properly. It might happen because the text is displayed in a QTextBrowser.

@adisuciu adisuciu added the v2.0 label Feb 4, 2025
@AlexandraTrifan
preferences: add a macro to handle all preferences creation.
9dde572 
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 <Alexandra.Trifan@analog.com>
@AlexandraTrifan
docs: auto generate the preference docs by searching for the pref macro.
43dedd6 
Signed-off-by: AlexandraTrifan <Alexandra.Trifan@analog.com>
@AlexandraTrifan AlexandraTrifan merged commit 39ec348 into main Feb 4, 2025
23 of 27 checks passed
@AlexandraTrifan AlexandraTrifan deleted the main-doc-prefs branch February 4, 2025 14:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@andreidanila1 andreidanila1 andreidanila1 approved these changes

@andrei47w andrei47w Awaiting requested review from andrei47w

@adisuciu adisuciu Awaiting requested review from adisuciu

@Andrei-Fabian-Pop Andrei-Fabian-Pop Awaiting requested review from Andrei-Fabian-Pop

@IonutMuthi IonutMuthi Awaiting requested review from IonutMuthi

@bindea-cristian bindea-cristian Awaiting requested review from bindea-cristian

Assignees
No one assigned
Labels
v2.0
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@AlexandraTrifan @bindea-cristian @andreidanila1 @adisuciu