mirror of
https://gitlab.freedesktop.org/NetworkManager/NetworkManager.git
synced 2026-01-06 03:50:17 +01:00
c9ced304d2
In some cases, properties documentation might require to provide an explanation of each of the possible values that the property accepts. If the possible values are the variants of an enum, we can use the introspection data to get all the possible values for that enum and their descriptions. With that info, we can automatically generate the documentation with an always up to date list of accepted values. Add a new "expand enumvals" feature: it will convert a token with the format `#EnumName:*` to a list of all the possible values. For the docbook (description-docbook field in the XML), it is expanded to a bulleted list of all the values and their respective documentations. This feature is limited to the "property-infos" comments (those like ---nmcli---, ---dbus---, etc). This comments are used only to generate the nm-settings-* manual pages. For the documentation under the doc/ folder this is not needed: it's not supported by gtkdoc and, anyway, it's better to use just `#EnumName` that will generate an HTML link. Additionally, expansion of `%ENUM_VALUE` is now supported in the property-infos comments. Instead of expanding them in the same style than gtkdoc "ENUM_VALUE (num)", it is expanded in a format more suitable for the nm-setting-* manual pages: - for nmcli: value_nick (num) - others: num (value_nick) Also, fix typo in meson build file propery -> property. |
||
|---|---|---|
| .. | ||
| nm-guest-data | ||
| check-compare-generated.sh | ||
| check-config-options.sh | ||
| check-docs.sh | ||
| check-exports.sh | ||
| check-gitlab-ci.sh | ||
| check-nm-autoptr.sh | ||
| check-tree.sh | ||
| check-vapi.sh | ||
| create-exports-NetworkManager.sh | ||
| debug-helper.py | ||
| enums-to-docbook.pl | ||
| generate-docs-nm-property-infos.py | ||
| generate-docs-nm-settings-docs-gir.py | ||
| generate-docs-nm-settings-docs-merge.py | ||
| generate-docs-settings-docs.py | ||
| meson-post-install.sh | ||
| nm-in-container | ||
| nm-in-vm | ||
| run-nm-test.sh | ||
| test-build.sh | ||
| test-cloud-meta-mock.py | ||
| test-networkmanager-service.py | ||
| test-sudo-wrapper.sh | ||