From 4bca46394492db2ae328d77d43bfcb17be721132 Mon Sep 17 00:00:00 2001
From: Dietmar Maurer <dietmar@proxmox.com>
Date: Mon, 2 Dec 2019 20:06:14 +0100
Subject: [PATCH] proxmox-api/src/format.rs: improve docs

---
 proxmox-api/src/format.rs | 14 +++++++++-----
 1 file changed, 9 insertions(+), 5 deletions(-)

diff --git a/proxmox-api/src/format.rs b/proxmox-api/src/format.rs
index 9d83eb0f..6fb4f4b1 100644
--- a/proxmox-api/src/format.rs
+++ b/proxmox-api/src/format.rs
@@ -7,24 +7,28 @@ use super::router::{Router, SubRoute};
 use super::schema::*;
 use super::{ApiHandler, ApiMethod};
 
+/// Enumerate different styles to display parameters/properties.
 #[derive(Copy, Clone)]
 pub enum ParameterDisplayStyle {
+    /// Used for properties in configuration files: ``key:``
     Config,
     //SonfigSub,
+    /// Used for command line options: ``--key``
     Arg,
+    /// Used for command line options passed as arguments: ``<key>``
     Fixed,
 }
 
-/// CLI usage information format
+/// CLI usage information format.
 #[derive(Copy, Clone, PartialEq)]
 pub enum DocumentationFormat {
-    /// text, command line only (one line)
+    /// Text, command line only (one line).
     Short,
-    /// text, list all options
+    /// Text, list all options.
     Long,
-    /// text, include description
+    /// Text, include description.
     Full,
-    /// like full, but in reStructuredText format
+    /// Like full, but in reStructuredText format.
     ReST,
 }