summaryrefslogtreecommitdiff
path: root/schema/interface_definition.rnc
diff options
context:
space:
mode:
Diffstat (limited to 'schema/interface_definition.rnc')
-rw-r--r--schema/interface_definition.rnc14
1 files changed, 13 insertions, 1 deletions
diff --git a/schema/interface_definition.rnc b/schema/interface_definition.rnc
index 758d9ce1c..a338b875f 100644
--- a/schema/interface_definition.rnc
+++ b/schema/interface_definition.rnc
@@ -1,6 +1,6 @@
# interface_definition.rnc: VyConf reference tree XML grammar
#
-# Copyright (C) 2014. 2017 VyOS maintainers and contributors <maintainers@vyos.net>
+# Copyright VyOS maintainers and contributors <maintainers@vyos.io>
#
# This library is free software; you can redistribute it and/or
# modify it under the terms of the GNU Lesser General Public
@@ -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 })? &