fpsdk_doc.hpp

/**
 * \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

    The Fixposition SDK provides building blocks to write apps to use with Fixposition products, namely the Vision-RTK 2
    sensor. Some apps to test and demponstrate some of the functionality are included. Some examples are provided to
    demonstrate the suggested use of some of the functionality.

    This documentation covers installation and building of the Fixposition SDK (and the included apps), the examples
    and the API for your own apps.

    @image html fpsdk-overview.drawio.svg

    @section FPSDK_PACKAGES Packages and API

    The SDK consists of the following packages:

    - @subpage FPSDK_COMMON_DOC
    - @subpage FPSDK_ROS1_DOC
    - @subpage FPSDK_ROS2_DOC
    - @subpage FPSDK_APPS_DOC

    @section FPSDK_EXAMPLES Examples

    See @ref FPSDK_EXAMPLES_DOC.

    @section FPSDK_BUILD Building, installing, dependencies

    See @ref FPSDK_BUILD_DOC.

    @section FP_REFS References

    - Fixposition SDK source code repository: https://github.com/fixposition/fixposition-sdk

    @section FPSDK_LICENSE Licenses

    See the LICENSE file included in the source of each package or the generated documentation (@ref
    FPSDK_COMMON_LICENSE, @ref FPSDK_ROS1_LICENSE, @ref FPSDK_ROS2_LICENSE and @ref FPSDK_APPS_LICENSE).
*/

// clang-format on
/* ****************************************************************************************************************** */
}  // namespace fpsdk
#endif  // __FPSDK_DOC_HPP__