Fixposition SDK 0.0.0-heads/main-0-g5c7edb5
Collection of c++ libraries and apps for use with Fixposition products on Linux
Loading...
Searching...
No Matches
doc.hpp
Go to the documentation of this file.
1/**
2 * \verbatim
3 * ___ ___
4 * \ \ / /
5 * \ \/ / Copyright (c) Fixposition AG (www.fixposition.com) and contributors
6 * / /\ \ License: see the LICENSE file
7 * /__/ \__\
8 * \endverbatim
9 *
10 * @file
11 * @brief Fixposition SDK: apps documentation
12 */
13
14#ifndef __FPSDK_APPS_DOC_HPP__
15#define __FPSDK_APPS_DOC_HPP__
16
17namespace fpsdk {
18/**
19 * @brief Fixposition SDK: Apps
20 */
21namespace apps {
22// clang-format off
23/* ****************************************************************************************************************** */
24
25/*!
26 @page FPSDK_APPS_DOC Fixposition SDK: Apps
27
28 @section FPSDK_APPS_OVERVIEW Overview
29
30 Several apps ("tools", "utilities") are provided. They are useful as-is but are also meant to demonstrate the
31 use of the @ref FPSDK_COMMON_DOC and serve as a basis for users to build their own tools.
32
33 See @ref FPSDK_BUILD_DOC on how to build and run the apps, or @ref FPSDK_RUN_DOC on how to run the apps.
34
35 @section FPSDK_APPS_APPS Apps
36
37 - @subpage FPSDK_APPS_FPLTOOL
38 - @subpage FPSDK_APPS_PARSERTOOL
39 - @subpage FPSDK_APPS_TIMECONV
40 - @subpage FPSDK_APPS_YAML2SHELL
41
42 @section FPSDK_APPS_LICENSE License
43
44 @include fpsdk_apps/LICENSE
45*/
46
47/* ****************************************************************************************************************** */
48// clang-format on
49} // namespace apps
50} // namespace fpsdk
51#endif // __FPSDK_APPS_DOC_HPP__
Fixposition SDK.