proxmox-mirrors/proxmox
1
0
Fork 1
mirror of https://git.proxmox.com/git/proxmox synced 2025-06-01 04:59:18 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

proxmox-api/src/format.rs: add missing docs

Browse Source
This commit is contained in:
Dietmar Maurer 2019-12-02 19:50:04 +01:00
parent 8f7127a9aa
commit 00f3a6575c
1 changed files with 6 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
proxmox-api/src/format.rs
View File

@ -68,7 +68,10 @@ fn test_wrap_text() {
assert_eq!(wrapped, expect); assert_eq!(wrapped, expect);
} }
/// TODO: Document output format. /// Helper to format the type text
///
/// The result is a short string including important constraints, for
/// example ``<integer> (0 - N)``.
pub fn get_schema_type_text(schema: &Schema, _style: ParameterDisplayStyle) -> String { pub fn get_schema_type_text(schema: &Schema, _style: ParameterDisplayStyle) -> String {
match schema { match schema {
Schema::Null => String::from("<null>"), // should not happen Schema::Null => String::from("<null>"), // should not happen
@ -85,7 +88,7 @@ pub fn get_schema_type_text(schema: &Schema, _style: ParameterDisplayStyle) -> S
} }
} }
/// TODO: Document output format. /// Helper to format an object property, including name, type and description.
pub fn get_property_description( pub fn get_property_description(
name: &str, name: &str,
schema: &Schema, schema: &Schema,
@ -246,7 +249,7 @@ fn dump_method_definition(method: &str, path: &str, def: Option<&ApiMethod>) ->
} }
} }
/// TODO: Document output format. /// Generate ReST Documentaion for a complete API defined by a ``Router``.
pub fn dump_api( pub fn dump_api(
output: &mut dyn Write, output: &mut dyn Write,
router: &Router, router: &Router,