forked from RobotLocomotion/drake
-
Notifications
You must be signed in to change notification settings - Fork 0
/
doxygen.h
60 lines (49 loc) · 2.03 KB
/
doxygen.h
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
/**
@mainpage
<h3>Overview</h3>
<p>Drake's C++ library is composed primarily of an interface for solving
numerical optimization problems, interfaces for modeling dynamical system,
and collection of state-of-the-art algorithms for optimization on dynamical
systems:</p>
<ul>
<li><a href="group__solvers.html">Formulating and Solving Optimization
Problems</a></li>
<li><a href="group__systems.html">Modeling Dynamical Systems</a></li>
<ul>
<li><a href="class_rigid_body_tree.html">Rigid-Body Kinematics and
Dynamics</a></li>
<li><a href="group__automotive__systems.html">Automotive Systems</a></li>
<li> \subpage stochastic_systems
</ul>
<li>Algorithms</li>
<ul>
<li><a href="classdrake_1_1systems_1_1_simulator.html">Simulation</a></li>
<li>Analysis</li>
<li>Planning</li>
<li>Feedback Control Design</li>
<li>State Estimation</li>
<li>System Identification</li>
</ul>
</ul>
<p>For more general information, you can also visit the <a
href="http://drake.mit.edu">Drake documentation main page</a>.</p>
</p>
<p>Drake's C++ libraries use a small amount of template metaprogramming to
enable more advanced features (autodiff, symbolic computation, etc). We
have tried to avoid users having to be expert template programmers, but this
is a good reference if you'd like to
<a href="http://www.generic-programming.org/languages/cpp/techniques.php">
learn more about generic programming</a>.</p>
<h3>How do I document the code I am contributing?</h3>
<p>
If you want to make your own Doxygen locally, run
<b><i>make documentation</i></b> or <b><i>ninja documentation</i></b> in
the <code>drake-distro/build/drake</code> directory. You may need to install Doxygen (e.g., with <i>sudo
apt-get install doxygen</i> on Ubuntu).</p>
<p>
<p><a href="https://www.stack.nl/~dimitri/doxygen/manual/docblocks.html">Check
out the Doxygen C++ documentation</a></p>
<p>Drake's Doxygen documentation is
<a href="http://drake.mit.edu">hosted online</a> for the master branch, but is
only updated nightly.</p>
*/