aboutsummaryrefslogtreecommitdiff
path: root/paludis/args/do_help.hh
blob: 19bdb60cb07308adb5c6042a44a2304a9398afb9 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
/* vim: set sw=4 sts=4 et foldmethod=syntax : */

/*
 * Copyright (c) 2006, 2007 Ciaran McCreesh
 *
 * This file is part of the Paludis package manager. Paludis is free software;
 * you can redistribute it and/or modify it under the terms of the GNU General
 * Public License version 2, as published by the Free Software Foundation.
 *
 * Paludis is distributed in the hope that it will be useful, but WITHOUT ANY
 * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
 * FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
 * details.
 *
 * You should have received a copy of the GNU General Public License along with
 * this program; if not, write to the Free Software Foundation, Inc., 59 Temple
 * Place, Suite 330, Boston, MA  02111-1307  USA
 */

#ifndef PALUDIS_GUARD_SRC_COMMON_ARGS_DO_HELP_HH
#define PALUDIS_GUARD_SRC_COMMON_ARGS_DO_HELP_HH 1

/** \file
 * Declarations for the DoHelp class.
 *
 * \ingroup g_args
 *
 * \section Examples
 *
 * - None at this time.
 */

namespace paludis
{
    namespace args
    {
        /**
         * Convenience struct for --help handling.
         *
         * \ingroup g_args
         */
        struct PALUDIS_VISIBLE DoHelp
        {
            /**
             * Our message, if one is necessary.
             */
            const std::string message;

            ///\name Basic operations
            ///\{

            DoHelp(const std::string & m = "") :
                message(m)
            {
            }

            ///\}
        };
    }
}


#endif