yaml2shell_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: yaml2shell documentation
 */
 
#ifndef __FPSDK_APPS_YAML2SHELL_DOC_HPP__
#define __FPSDK_APPS_YAML2SHELL_DOC_HPP__
 
namespace fpsdk {
namespace apps {
/**
 * @brief streammux
 */
namespace streammux {
// clang-format off
/* ****************************************************************************************************************** */
 
/*!
    @page FPSDK_APPS_YAML2SHELL yaml2shell
 
    @section FPSDK_APPS_YAML2SHELL_OVERVIEW Overview
 
    Tool to convert a yaml document to shell variables.
 
    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_YAML2SHELL_HELP Command line help
 
    @include yaml2shell_helpscreen.txt
 
*/
 
/* ****************************************************************************************************************** */
// clang-format on
}  // namespace streammux
}  // namespace apps
}  // namespace fpsdk
#endif  // __FPSDK_APPS_YAML2SHELL_DOC_HPP__