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

doc: show full preference names #3189

Merged
merged 1 commit into from
Nov 20, 2024

Conversation

mdavidsaver
Copy link
Contributor

@mdavidsaver mdavidsaver commented Nov 13, 2024

As a follow on to #3187. Prepend package names when generating preference_properties.html so they appear complete, because clearly users will copy+paste without reading the page preamble.

I couldn't immediately see a way to compute the package name from the preferences file name, so I opt to parse out the # Package ... line present in (almost) all files. This parsing is simplistic, looking at the first non-space character. It also can not fix preference names which appear in comments.

Did I guess the correct package for app/databrowser-json/src/main/resources/archive_reader_json_preferences.properties?

Copy link
Collaborator

@kasemir kasemir left a comment

Choose a reason for hiding this comment

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

Good idea.

@kasemir
Copy link
Collaborator

kasemir commented Nov 13, 2024

Did I guess the correct package for app/databrowser-json/src/main/resources/archive_reader_json_preferences.properties?

The actual package is org.phoebus.archive.reader.json.

@mdavidsaver
Copy link
Contributor Author

The actual package is org.phoebus.archive.reader.json.

Updated.

@shroffk shroffk merged commit b681616 into ControlSystemStudio:master Nov 20, 2024
1 check passed
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.

3 participants