Updating docs.
This commit is contained in:
parent
971f324d7f
commit
ce21bbd38a
|
@ -435,7 +435,7 @@ LOOKUP_CACHE_SIZE = 0
|
||||||
# normally produced when WARNINGS is set to YES.
|
# normally produced when WARNINGS is set to YES.
|
||||||
# The default value is: NO.
|
# The default value is: NO.
|
||||||
|
|
||||||
EXTRACT_ALL = NO
|
EXTRACT_ALL = YES
|
||||||
|
|
||||||
# If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will
|
# If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will
|
||||||
# be included in the documentation.
|
# be included in the documentation.
|
||||||
|
@ -453,7 +453,7 @@ EXTRACT_PACKAGE = NO
|
||||||
# included in the documentation.
|
# included in the documentation.
|
||||||
# The default value is: NO.
|
# The default value is: NO.
|
||||||
|
|
||||||
EXTRACT_STATIC = NO
|
EXTRACT_STATIC = YES
|
||||||
|
|
||||||
# If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined
|
# If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined
|
||||||
# locally in source files will be included in the documentation. If set to NO,
|
# locally in source files will be included in the documentation. If set to NO,
|
||||||
|
@ -820,45 +820,11 @@ FILE_PATTERNS = *.c \
|
||||||
*.cxx \
|
*.cxx \
|
||||||
*.cpp \
|
*.cpp \
|
||||||
*.c++ \
|
*.c++ \
|
||||||
*.java \
|
|
||||||
*.ii \
|
|
||||||
*.ixx \
|
|
||||||
*.ipp \
|
|
||||||
*.i++ \
|
|
||||||
*.inl \
|
|
||||||
*.idl \
|
|
||||||
*.ddl \
|
|
||||||
*.odl \
|
|
||||||
*.h \
|
*.h \
|
||||||
*.hh \
|
*.hh \
|
||||||
*.hxx \
|
*.hxx \
|
||||||
*.hpp \
|
*.hpp \
|
||||||
*.h++ \
|
*.h++ \
|
||||||
*.cs \
|
|
||||||
*.d \
|
|
||||||
*.php \
|
|
||||||
*.php4 \
|
|
||||||
*.php5 \
|
|
||||||
*.phtml \
|
|
||||||
*.inc \
|
|
||||||
*.m \
|
|
||||||
*.markdown \
|
|
||||||
*.md \
|
|
||||||
*.mm \
|
|
||||||
*.dox \
|
|
||||||
*.py \
|
|
||||||
*.pyw \
|
|
||||||
*.f90 \
|
|
||||||
*.f95 \
|
|
||||||
*.f03 \
|
|
||||||
*.f08 \
|
|
||||||
*.f \
|
|
||||||
*.for \
|
|
||||||
*.tcl \
|
|
||||||
*.vhd \
|
|
||||||
*.vhdl \
|
|
||||||
*.ucf \
|
|
||||||
*.qsf
|
|
||||||
|
|
||||||
# The RECURSIVE tag can be used to specify whether or not subdirectories should
|
# The RECURSIVE tag can be used to specify whether or not subdirectories should
|
||||||
# be searched for input files as well.
|
# be searched for input files as well.
|
||||||
|
@ -873,7 +839,7 @@ RECURSIVE = YES
|
||||||
# Note that relative paths are relative to the directory from which doxygen is
|
# Note that relative paths are relative to the directory from which doxygen is
|
||||||
# run.
|
# run.
|
||||||
|
|
||||||
EXCLUDE = ../build/ ../cmake-debug-build/ ../extern/ ../test/
|
EXCLUDE = ../build/* ../cmake-build-debug/* ../extern/* ../test/* ../docs/*
|
||||||
|
|
||||||
# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
|
# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
|
||||||
# directories that are symbolic links (a Unix file system feature) are excluded
|
# directories that are symbolic links (a Unix file system feature) are excluded
|
||||||
|
@ -889,7 +855,7 @@ EXCLUDE_SYMLINKS = NO
|
||||||
# Note that the wildcards are matched against the file with absolute path, so to
|
# Note that the wildcards are matched against the file with absolute path, so to
|
||||||
# exclude all test directories for example use the pattern */test/*
|
# exclude all test directories for example use the pattern */test/*
|
||||||
|
|
||||||
EXCLUDE_PATTERNS =
|
EXCLUDE_PATTERNS = */build/* */cmake-build-debug/* */extern/* */test/* */docs/*
|
||||||
|
|
||||||
# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
|
# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
|
||||||
# (namespaces, classes, functions, etc.) that should be excluded from the
|
# (namespaces, classes, functions, etc.) that should be excluded from the
|
||||||
|
|
|
@ -1,3 +1,7 @@
|
||||||
|
/// \file madgwick.h
|
||||||
|
/// \brief Implementation of a Madgwick filter.
|
||||||
|
///
|
||||||
|
/// See [the paper](http://x-io.co.uk/res/doc/madgwick_internal_report.pdf).
|
||||||
#ifndef __WRMATH_FILTER_MADGWICK_H
|
#ifndef __WRMATH_FILTER_MADGWICK_H
|
||||||
#define __WRMATH_FILTER_MADGWICK_H
|
#define __WRMATH_FILTER_MADGWICK_H
|
||||||
|
|
||||||
|
@ -7,6 +11,7 @@
|
||||||
|
|
||||||
|
|
||||||
namespace wr {
|
namespace wr {
|
||||||
|
/// filter contains filtering algorithms.
|
||||||
namespace filter {
|
namespace filter {
|
||||||
|
|
||||||
|
|
||||||
|
@ -75,7 +80,7 @@ public:
|
||||||
/// Update the sensor frame with a gyroscope reading.
|
/// Update the sensor frame with a gyroscope reading.
|
||||||
///
|
///
|
||||||
/// \param gyro A three-dimensional vector containing gyro readings
|
/// \param gyro A three-dimensional vector containing gyro readings
|
||||||
/// as \f$<\omega_x, \omega_y, \omega_z\>f$.
|
/// as \f$<\omega_{x}, \omega_y, \omega_z>\f$.
|
||||||
/// \param delta The time step between readings. It must not be zero.
|
/// \param delta The time step between readings. It must not be zero.
|
||||||
void
|
void
|
||||||
updateAngularOrientation(const geom::Vector<T, 3> &gyro, T delta)
|
updateAngularOrientation(const geom::Vector<T, 3> &gyro, T delta)
|
||||||
|
|
|
@ -7,6 +7,7 @@
|
||||||
|
|
||||||
|
|
||||||
namespace wr {
|
namespace wr {
|
||||||
|
/// math contains utility math functions.
|
||||||
namespace math {
|
namespace math {
|
||||||
|
|
||||||
|
|
||||||
|
|
|
@ -1 +0,0 @@
|
||||||
#include "wrmath/filter/madgwick.h"
|
|
Loading…
Reference in New Issue