documentinator 0.0.8

ROS2 documentation generator 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62

//! Serializable documentation structures.

use serde_derive::{Deserialize, Serialize};

/// Top level Doc representation
#[derive(Deserialize, Serialize, Clone, Ord, PartialOrd, Eq, PartialEq, Debug, Hash, Default)]
pub struct Doc {
    /// Name of the package containing all of the nodes in this doc.
    pub package_name: String,
    /// Optional link to the repo containing this package.
    pub repo: Option<String>,
    /// The nodes in this package.
    pub nodes: Vec<Node>,
}

#[derive(Deserialize, Serialize, Clone, Ord, PartialOrd, Eq, PartialEq, Debug, Hash, Default)]
pub struct Node {
    /// Name of the node
    pub node_name: String,
    /// Source file(s) of the node
    pub source_file: Vec<String>,
    /// Summary of functionality
    pub summary: String,
    /// Description of potential improvements to the node
    pub potential_improvements: Option<String>,
    /// Anything else to be included in the documentation
    pub misc: Option<String>,
    /// Topics published to, if any
    pub publishes: Option<Vec<Topic>>,
    /// Topics subscribed to, if any
    pub subscribes: Option<Vec<Topic>>,
    /// Node Parameters
    pub params: Option<Vec<Param>>,
    /// Launchfile information
    pub launch: Option<Vec<LaunchInfo>>,
}

#[derive(Deserialize, Serialize, Clone, Ord, PartialOrd, Eq, PartialEq, Debug, Hash, Default)]
pub struct Topic {
    pub name: String,
    pub description: String,
}

#[derive(Deserialize, Serialize, Clone, Ord, PartialOrd, Eq, PartialEq, Debug, Hash, Default)]
pub struct Param {
    pub name: String,
    pub description: String,
}

#[derive(Deserialize, Serialize, Clone, Ord, PartialOrd, Eq, PartialEq, Debug, Hash, Default)]
pub struct LaunchInfo {
    pub file_path: String,
    pub usage: String,
    pub args: Option<Vec<Param>>,
    pub remap: Option<Vec<Remap>>
}

#[derive(Deserialize, Serialize, Clone, Ord, PartialOrd, Eq, PartialEq, Debug, Hash, Default)]
pub struct Remap {
    pub from: String,
    pub to: String
}