fpsdk_doc.hpp

Go to the documentation of this file.

/**
 * \verbatim
 * ___    ___
 * \  \  /  /
 *  \  \/  /   Copyright (c) Fixposition AG (www.fixposition.com) and contributors
 *  /  /\  \   License: see the LICENSE file
 * /__/  \__\
 * \endverbatim
 *
 * @file
 * @brief Fixposition SDK: Documentation
 */
 
#ifndef __FPSDK_DOC_HPP__
#define __FPSDK_DOC_HPP__
 
/**
 * @brief Fixposition SDK
 */
namespace fpsdk {
/* ****************************************************************************************************************** */
// clang-format off
 
/*!
    @mainpage
 
    @section FPSDK_OVERVIEW Overview
 
    This is the reference documentation of the Fixposition SDK API. For examples and building instructions see the
    provided apps (e.g. the "fpltool" in fpsdk_apps/fpltool/), the CI scripts or the various README.md files.
 
    @image html fpsdk-overview.drawio.svg
 
    @section FPSDK_PACKAGES Packages
 
    - @subpage FPSDK_COMMON_DOC
    - @subpage FPSDK_ROS1_DOC
    - @subpage FPSDK_ROS2_DOC
    - @subpage FPSDK_APPS_DOC
 
    @section FP_REFS References
 
    - Fixposition SDK source code repository: https://github.com/fixposition/fixposition_utility
 
    @section FPSDK_LICENSE Licenses
 
    See the LICENSE files of the individual packages, included in the documentation linked above.
 
*/
 
// clang-format on
/* ****************************************************************************************************************** */
}  // namespace fpsdk
#endif  // __FPSDK_DOC_HPP__