From eb6b6277419b777905d8c84acf29824588a70ea3 Mon Sep 17 00:00:00 2001
From: Sebastian Tobie <sebastian@sebastian-tobie.de>
Date: Sat, 15 Apr 2023 12:37:03 +0200
Subject: [PATCH] updated the documentation

---
 plugins/modules/systemd_link.py    |  2 +-
 plugins/modules/systemd_network.py | 57 +++++++++++++++++++++---------
 2 files changed, 41 insertions(+), 18 deletions(-)

diff --git a/plugins/modules/systemd_link.py b/plugins/modules/systemd_link.py
index 217ba08..a43460f 100644
--- a/plugins/modules/systemd_link.py
+++ b/plugins/modules/systemd_link.py
@@ -137,7 +137,7 @@ options:
   name:
     description:
     - The new name of the device
-    required: false
+    required: true
     type: str
   path:
     description:
diff --git a/plugins/modules/systemd_network.py b/plugins/modules/systemd_network.py
index 161eb78..b4a9987 100644
--- a/plugins/modules/systemd_network.py
+++ b/plugins/modules/systemd_network.py
@@ -25,17 +25,17 @@ class Module(SystemdUnitModule):
     name = "systemd_network"
     module_spec = dict(
         argument_spec=dict(
-            mac=Types.str(),
-            device=Types.str(),
-            name=Types.str(required=True),
-            description=Types.str(),
-            dot=Types.bool(),
-            dnssec=Types.bool(),
-            dns=Types.list(elements=str),
-            domain=Types.list(elements=str),
-            defaultdns=Types.bool(),
-            address=Types.list(elements=str, required=True),
-            route=Types.list(elements=str),
+            mac=Types.str(help="The MAC-Address of the device"),
+            device=Types.str(help="The name of the network device"),
+            name=Types.str(required=True, help="name of the unit"),
+            description=Types.str(help="An optional description"),
+            dot=Types.bool(help="if DNS-over-TLS should be required or disabled. If it is unset, it will used if the server supports it"),
+            dnssec=Types.bool("if the Domainqueries should require DNSSEC or not. If its missing, domains that have DNSSEC enabled will be validated, all others it will be assumed to be okay."),
+            dns=Types.list(elements=str, help="List of DNS-Servers"),
+            domain=Types.list(elements=str, help="List of domains that are on this device"),
+            defaultdns=Types.bool(help="If the DNS-Server(s) on this device should be used for all domains that are not set on other devices"),
+            address=Types.list(elements=str, required=True, help="IP-Addresses of this networkdevice"),
+            route=Types.list(elements=str, help="Routes of networks that can be reached with this device"),
         ),
         required_if=(("defaultdns", True, ("dns",), False),),
         required_one_of=(("mac", "device"),),
@@ -115,45 +115,68 @@ description:
 module: systemd_network
 options:
   address:
+    description:
+    - IP-Addresses of this networkdevice
     elements: str
     required: true
     type: list
   defaultdns:
+    description:
+    - If the DNS-Server(s) on this device should be used for all domains that are
+      not set on other devices
     required: false
     type: bool
   description:
+    description:
+    - An optional description
+    required: false
+    type: str
+  device:
+    description:
+    - The name of the network device
     required: false
     type: str
   dns:
     default: []
+    description:
+    - List of DNS-Servers
     elements: str
     required: false
     type: list
   dnssec:
-    required: false
+    required: true
     type: bool
   domain:
     default: []
+    description:
+    - List of domains that are on this device
     elements: str
     required: false
     type: list
   dot:
+    description:
+    - if DNS-over-TLS should be required or disabled. If it is unset, it will used
+      if the server supports it
     required: false
     type: bool
+  mac:
+    description:
+    - The MAC-Address of the device
+    required: false
+    type: str
   name:
+    description:
+    - name of the unit
     required: true
     type: str
-  mac:
-    elements: str
-    required: true
-    type: list
   route:
     default: []
+    description:
+    - Routes of networks that can be reached with this device
     elements: str
     required: false
     type: list
 short_description: Sets up the systemd network unit
-
 """