Skip to content

Improve documents about xaml comments #40

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

Merged
merged 2 commits into from
Sep 20, 2025
Merged

Improve documents about xaml comments #40

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4271bd9
Improve documents about xaml comments
Jack251970 Sep 20, 2025
c8eae40
Fix typos
Jack251970 Sep 20, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 18 additions & 0 deletions localization-toolkit.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,24 @@ To this:
Localize.flowlauncher_plugin_localization_demo_value_with_keys(firstName, lastName);
```

If you would like to add summary for functions of localization strings, you need to comment strings in xaml files like this:
```xml
<!--
<summary>Demo plugin name</summary>
-->
<system:String x:Key="flowlauncher_plugin_localization_demo_plugin_name">Demo</system:String>
```

Or if you would like to change the default types or names of variables in localization strings, you need to comment strings in xaml file like this:
```xml
<!--
<param index="0" name="value0" type="object" />
<param index="1" name="value1" type="string" />
<param index="2" name="value2" type="int" />
-->
<system:String x:Key="flowlauncher_plugin_localization_demo_value_with_keys">Demo {2:00}, {1,-35:D} and {0}</system:String>
```

### Localized Enums

For enum types (e.g., `DemoEnum`) that need localization in UI controls such as combo boxes, use the `EnumLocalize` attribute to enable localization. For each enum field:
Expand Down
Loading