Skip to content

Commit 23b82cd

Browse files
Add class documentation.
1 parent 8e89d97 commit 23b82cd

File tree

2 files changed

+11
-0
lines changed

2 files changed

+11
-0
lines changed

include/dynamic-graph/tutorial/feedback-controller.hh

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,11 @@ namespace dynamicgraph {
3535
return CLASS_NAME;
3636
}
3737

38+
/// Header documentation of the python class
39+
virtual std::string getDocString () const {
40+
return
41+
"Feedback controller aimed at maintaining the pendulum vertical\n";
42+
}
3843
/**
3944
\name Parameters
4045
@{

include/dynamic-graph/tutorial/inverted-pendulum.hh

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -95,6 +95,12 @@ namespace dynamicgraph {
9595
return CLASS_NAME;
9696
}
9797

98+
/// Header documentation of the python class
99+
virtual std::string getDocString () const {
100+
return
101+
"Classical inverted pendulum dynamic model\n";
102+
}
103+
98104
/// Integrate equation of motion over time step given as input
99105
void incr(double inTimeStep);
100106

0 commit comments

Comments
 (0)