Read-only mirrors. Development, issues and pull requests are on GitHub.

summaryrefslogtreecommitdiffhomepage
path: root/Headers/Progmasoft/Tazelish/Help.hpp
blob: d7254c75c7421ce7ca0f7579aa496024857a5385 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
// SPDX-FileCopyrightText: 2026 Progmasoft <support@progmasoft.com>
// SPDX-License-Identifier: MPL-2.0 WITH AdditionRef-Progmasoft-Exception-2.0

/// \file
/// The text `tazelish help` prints.

#pragma once

#include <optional>
#include <string_view>

#include "Progmasoft/Tazelish/CommandLine.hpp"

namespace Progmasoft::Tazelish
{

    /// The general help without a topic, or the help of one command.
    [[nodiscard]] std::string_view
    HelpText(std::optional<Topic> topic);

} // namespace Progmasoft::Tazelish