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
Comment on lines
+284
to
+285
| "the current state of the application." | ||
| "Important messages such as connection done or alerts are displayed here.", |
There was a problem hiding this comment.
A space must be placed after application.
Comment on lines
+289
to
+290
| "Indicates whether the plot grid is visible across the application." | ||
| "The user can enable or disable this in order to configure the ", |
Comment on lines
+305
to
+306
| "Indicates whether native dialogs should be used in the application." | ||
| "This setting allows the user to enable or disable the use of native file " |
Comment on lines
+313
to
+314
| "Scale factor for the font size used across the application, suitable for " | ||
| "different display settings", |
Comment on lines
+318
to
+319
| "Theme setting for the application interface." | ||
| "The user can choose between Harmonic style (light or dark) or Scopy style.", |
Comment on lines
+329
to
+330
| "to handle them separately using different sections in the left side menu." | ||
| "Due to not being tested using enough scenarios it is still marked as an experimental feature.", |
Comment on lines
+318
to
+319
| "Enable/disable the configuration panel for ADC digital filters." | ||
| "This allows manual control over the parameters of the filters.", |
Comment on lines
+342
to
+343
| "Select whether the 0dB value is displayed as a reference point on the" | ||
| "Network Analyzer plot. This control is disabled by default.", |
There was a problem hiding this comment.
Include space between "the" and "Network".
Comment on lines
+347
to
+348
| "Select the number of displayed signal periods in the Signal Generator." | ||
| "Default value is 2.", |
There was a problem hiding this comment.
Include space between sentences.
Comment on lines
+122
to
+123
| "Select whether the Y-Axis handle is located on the left or right side of the plot." | ||
| "Only applied after restart.", |
There was a problem hiding this comment.
Include space between sentences.
Comment on lines
+130
to
+131
| "Select whether the X-Axis cursor handles are located on the top or bottom of the plot." | ||
| "Only applied after restart.", |
There was a problem hiding this comment.
Include space between sentences.
Comment on lines
+138
to
+139
| "Select whether the Y-Axis cursor handles are located on the left or right side of the plot." | ||
| "Only applied after restart.", |
There was a problem hiding this comment.
Include space between sentences.
Comment on lines
+146
to
+147
| "%Full Scale. This is also controllable while running, from the instrument settings." | ||
| "Only applied after restart.", |
There was a problem hiding this comment.
Include space between sentences.
bindea-cristian
approved these changes
Jan 29, 2025
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.