auxiliary.hpp

Go to the documentation of this file.

// SPDX-FileCopyrightText: 2006-2024, Knut Reinert & Freie Universität Berlin
// SPDX-FileCopyrightText: 2016-2024, Knut Reinert & MPI für molekulare Genetik
// SPDX-License-Identifier: BSD-3-Clause
 
#pragma once
 
#include <string>
#include <vector>
 
#include <sharg/platform.hpp>
 
namespace sharg
{
 
enum class update_notifications
{
    on, 
    off 
};
 
struct parser_meta_data // holds all meta information
{
    std::string app_name;
 
    std::string version;
 
    std::string short_description;
 
    std::string author;
 
    std::string email;
 
    std::string date;
 
    std::string url;
 
    std::string short_copyright;
 
    std::string long_copyright;
 
    std::string citation;
 
    std::string man_page_title;
 
    unsigned man_page_section{1};
 
    std::vector<std::string> description;
 
    std::vector<std::string> synopsis;
 
    std::vector<std::string> examples;
};
 
} // namespace sharg