mirror of
https://gitlab.freedesktop.org/NetworkManager/NetworkManager.git
synced 2026-05-17 01:48:07 +02:00
87df1130bd
When using "enumval expansion" in documentation comments (i.e.
"#IPTunnelMode:*"), sometimes there are values that are only for
internal usage, and not intended to be used from public APIs. Sometimes
this value is even rejected when trying to set it from public APIs.
Allow to prevent values from appearing in public APIs documentation,
marking it with the custom annotation "(attribute NM.internal=1)".
Note: currently, gtkdoc doesn't support annotations on enum fields when
using the inline style "@ENUM_VALUE_NAME: description". Instead, a
docblock needs to be used:
enum EnumTypeName {
/**
* ENUM_VALUE_NAME: (attributes NM.internal=1)
*
* description
*/
ENUM_VALUE_NAME
...
}
|
||
|---|---|---|
| .. | ||
| nm-in-container | ||
| 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 | ||
| run-nm-test.sh | ||
| test-build.sh | ||
| test-cloud-meta-mock.py | ||
| test-networkmanager-service.py | ||
| test-sudo-wrapper.sh | ||