Drake
doxygen.h
Go to the documentation of this file.
1 
2 /**
3 @mainpage
4 <h3>Overview</h3>
5 
6 <p>Drake's C++ library is composed primarily of an interface for solving
7  numerical optimization problems, interfaces for modeling dynamical system,
8  and collection of state-of-the-art algorithms for optimization on dynamical
9  systems:</p>
10 <ul>
11  <li><a href="group__solvers.html">Formulating and Solving Optimization
12  Problems</a></li>
13  <li><a href="group__systems.html">Modeling Dynamical Systems</a></li>
14  <ul>
15  <li><a href="class_rigid_body_tree.html">Rigid-Body Kinematics and
16  Dynamics</a></li>
17  <li><a href="group__automotive__systems.html">Automotive Systems</a></li>
18  <li> \subpage stochastic_systems
19  </ul>
20  <li>Algorithms</li>
21  <ul>
22  <li><a href="classdrake_1_1systems_1_1_simulator.html">Simulation</a></li>
23  <li>Analysis</li>
24  <li>Planning</li>
25  <li>Feedback Control Design</li>
26  <li>State Estimation</li>
27  <li>System Identification</li>
28  </ul>
29 </ul>
30 <p>For more general information, you can also visit the <a
31  href="http://drake.mit.edu">Drake documentation main page</a>.</p>
32 </p>
33 
34 <p>Drake's C++ libraries use a small amount of template metaprogramming to
35  enable more advanced features (autodiff, symbolic computation, etc). We
36  have tried to avoid users having to be expert template programmers, but this
37  is a good reference if you'd like to
38  <a href="http://www.generic-programming.org/languages/cpp/techniques.php">
39  learn more about generic programming</a>.</p>
40 
41 <h3>How do I document the code I am contributing?</h3>
42 
43 <p>
44 If you want to make your own Doxygen locally, run
45 <b><i>make documentation</i></b> or <b><i>ninja documentation</i></b> in
46 the <code>drake-distro/build/drake</code> directory. You may need to install Doxygen (e.g., with <i>sudo
47 apt-get install doxygen</i> on Ubuntu).</p>
48 <p>
49 
50 <p><a href="https://www.stack.nl/~dimitri/doxygen/manual/docblocks.html">Check
51 out the Doxygen C++ documentation</a></p>
52 
53 <p>Drake's Doxygen documentation is
54 <a href="http://drake.mit.edu">hosted online</a> for the master branch, but is
55 only updated nightly.</p>
56 
57 */
58 
59 
60