paludis  Version 2.6.0
do_help.hh
Go to the documentation of this file.
1 /* vim: set sw=4 sts=4 et foldmethod=syntax : */
2 
3 /*
4  * Copyright (c) 2006, 2007, 2011 Ciaran McCreesh
5  *
6  * This file is part of the Paludis package manager. Paludis is free software;
7  * you can redistribute it and/or modify it under the terms of the GNU General
8  * Public License version 2, as published by the Free Software Foundation.
9  *
10  * Paludis is distributed in the hope that it will be useful, but WITHOUT ANY
11  * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
12  * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
13  * details.
14  *
15  * You should have received a copy of the GNU General Public License along with
16  * this program; if not, write to the Free Software Foundation, Inc., 59 Temple
17  * Place, Suite 330, Boston, MA 02111-1307 USA
18  */
19 
20 #ifndef PALUDIS_GUARD_SRC_COMMON_ARGS_DO_HELP_HH
21 #define PALUDIS_GUARD_SRC_COMMON_ARGS_DO_HELP_HH 1
22 
23 /** \file
24  * Declarations for the DoHelp class.
25  *
26  * \ingroup g_args
27  *
28  * \section Examples
29  *
30  * - None at this time.
31  */
32 
34 #include <string>
35 
36 namespace paludis
37 {
38  namespace args
39  {
40  /**
41  * Convenience struct for --help handling.
42  *
43  * \ingroup g_args
44  */
46  {
47  /**
48  * Our message, if one is necessary.
49  */
50  const std::string message;
51 
52  ///\name Basic operations
53  ///\{
54 
55  DoHelp(const std::string & m = "") :
56  message(m)
57  {
58  }
59 
60  ///\}
61  };
62  }
63 }
64 
65 
66 #endif
Definition: about_metadata-fwd.hh:23
const std::string message
Definition: do_help.hh:50
Definition: do_help.hh:45
#define PALUDIS_VISIBLE
Definition: attributes.hh:59