diff options
| author | rebortg <github@ghlr.de> | 2025-01-08 21:43:10 +0000 |
|---|---|---|
| committer | rebortg <github@ghlr.de> | 2025-01-08 21:43:10 +0000 |
| commit | 4e8c8a4bc0f1f2b79c3aadd5b2e8e0fed0ea0160 (patch) | |
| tree | b21de7e212cc2cfe3497aecd887409ff8a691c59 /schema/interface_definition.rnc | |
| parent | 7bf02bfb68139fca05523aa33f73a593211aa388 (diff) | |
| download | vyos-1x-4e8c8a4bc0f1f2b79c3aadd5b2e8e0fed0ea0160.tar.gz vyos-1x-4e8c8a4bc0f1f2b79c3aadd5b2e8e0fed0ea0160.zip | |
T6342: extend schema to handle documentation in the xml interface definition
Diffstat (limited to 'schema/interface_definition.rnc')
| -rw-r--r-- | schema/interface_definition.rnc | 12 |
1 files changed, 12 insertions, 0 deletions
diff --git a/schema/interface_definition.rnc b/schema/interface_definition.rnc index 758d9ce1c..9434f5d18 100644 --- a/schema/interface_definition.rnc +++ b/schema/interface_definition.rnc @@ -97,6 +97,18 @@ properties = element properties valueHelp* & (element constraintErrorMessage { text })? & completionHelp* & + + # "docs" is used to store documentation for a node in a structured format + # It is used to generate documentation for the CLI and Web docs + (element docs { + (element headline { text })? & + (element text { text })? & + (element usageExample { text })? & + (element hints { + attribute type { text }, + text + })* + })? & # These are meaningful only for leaf nodes (element valueless { empty })? & |