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: apps documentation
 */
 
#ifndef __FPSDK_APPS_DOC_HPP__
#define __FPSDK_APPS_DOC_HPP__
 
namespace fpsdk {
/**
 * @brief Fixposition SDK: Apps
 */
namespace apps {
// clang-format off
/* ****************************************************************************************************************** */
 
/*!
    @page FPSDK_APPS_DOC Fixposition SDK: Apps
 
    @section FPSDK_APPS_OVERVIEW Overview
 
    Several apps ("tools", "utilities") are provided. They are useful as-is but are also meant to demonstrate the
    use of the @ref FPSDK_COMMON_DOC and serve as a basis for users to build their own tools.
 
    See @ref FPSDK_BUILD_DOC on how to build and run the apps, or @ref FPSDK_RUN_DOC on how to run the apps.
 
    @section FPSDK_APPS_APPS Apps
 
    - @subpage FPSDK_APPS_FPLTOOL
    - @subpage FPSDK_APPS_PARSERTOOL
    - @subpage FPSDK_APPS_TIMECONV
    - @subpage FPSDK_APPS_TIMETOOL
    - @subpage FPSDK_APPS_YAML2SHELL
 
    @section FPSDK_APPS_LICENSE License
 
    @include fpsdk_apps/LICENSE
*/
 
/* ****************************************************************************************************************** */
// clang-format on
}  // namespace apps
}  // namespace fpsdk
#endif  // __FPSDK_APPS_DOC_HPP__