From f907fa2682fdac628315d8dfcdf3bfea6feb20b7 Mon Sep 17 00:00:00 2001 From: olivier-stasse <olivier.stasse@aist.go.jp> Date: Tue, 1 Mar 2011 06:00:18 +0900 Subject: [PATCH] Fix some problems to generate documentation. --- doc/Doxyfile.extra.in | 11 ++++++----- doc/additionalHeader/modules.hh | 8 +++++++- 2 files changed, 13 insertions(+), 6 deletions(-) diff --git a/doc/Doxyfile.extra.in b/doc/Doxyfile.extra.in index 67cb6e6a..bc1595db 100644 --- a/doc/Doxyfile.extra.in +++ b/doc/Doxyfile.extra.in @@ -1,9 +1,10 @@ -INPUT = @CMAKE_SOURCE_DIR@/include \ - @CMAKE_SOURCE_DIR@/doc/additionalHeader \ - @CMAKE_SOURCE_DIR@/src -IMAGE_PATH = @CMAKE_SOURCE_DIR@/doc/pictures +INPUT += @CMAKE_SOURCE_DIR@/include \ +@CMAKE_SOURCE_DIR@/doc/additionalHeader \ +@CMAKE_SOURCE_DIR@/src -TAGFILES = \ +IMAGE_PATH += @CMAKE_SOURCE_DIR@/doc/pictures + +TAGFILES += \ "@ABSTRACT_ROBOT_DYNAMICS_DOXYGENDOCDIR@/abstract-robot-dynamics.doxytag = @ABSTRACT_ROBOT_DYNAMICS_DOXYGENDOCDIR@" \ "@JRL_MAL_DOXYGENDOCDIR@/jrl-mal.doxytag = @JRL_MAL_DOXYGENDOCDIR@" \ "@JRL_DYNAMICS_DOXYGENDOCDIR@/jrl-dynamics.doxytag = @JRL_DYNAMICS_DOXYGENDOCDIR@" diff --git a/doc/additionalHeader/modules.hh b/doc/additionalHeader/modules.hh index d3b2ba5d..318efb15 100644 --- a/doc/additionalHeader/modules.hh +++ b/doc/additionalHeader/modules.hh @@ -40,7 +40,7 @@ implemented uses the single point mass model. If the masses of your robot legs and arms are too important to be ignored it is very likely that none of the algorithms will give a feasible pair of CoM-ZMP trajectories. -The first available algorithm is the preview algorithm \ref Kajita2003 and \ref Kajita2005. +The first available algorithm is the preview algorithm as formulated in \ref Kajita2003 and \ref Kajita2005. This algorithm is real-time if you do not change the foot-prints inside the preview window. If you do want to perform this modification you should see \ref Morisawa2007. @@ -58,6 +58,12 @@ Its description can be found in \ref Herdt2010. This problem is currently solved using ql written by Pr. Schittkowski (\ref Schittkowski2007 ). We thank him for letting us distribute his code in our LGPL code. +\section Documentation +The documentation is divided in the following sections: +<ul> + <li> \subpage Installing</li> +</ul> + \section References \anchor Kajita2003 S. Kajita and F. Kanehiro and K. Kaneko and K. Fujiwara and K. Harada and K. Yokoi and H. Hirukawa, -- GitLab