do_help.hh

Go to the documentation of this file.
00001 /* vim: set sw=4 sts=4 et foldmethod=syntax : */
00002 
00003 /*
00004  * Copyright (c) 2006, 2007 Ciaran McCreesh
00005  *
00006  * This file is part of the Paludis package manager. Paludis is free software;
00007  * you can redistribute it and/or modify it under the terms of the GNU General
00008  * Public License version 2, as published by the Free Software Foundation.
00009  *
00010  * Paludis is distributed in the hope that it will be useful, but WITHOUT ANY
00011  * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
00012  * FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
00013  * details.
00014  *
00015  * You should have received a copy of the GNU General Public License along with
00016  * this program; if not, write to the Free Software Foundation, Inc., 59 Temple
00017  * Place, Suite 330, Boston, MA  02111-1307  USA
00018  */
00019 
00020 #ifndef PALUDIS_GUARD_SRC_COMMON_ARGS_DO_HELP_HH
00021 #define PALUDIS_GUARD_SRC_COMMON_ARGS_DO_HELP_HH 1
00022 
00023 /** \file
00024  * Declarations for the DoHelp class.
00025  *
00026  * \ingroup g_args
00027  *
00028  * \section Examples
00029  *
00030  * - None at this time.
00031  */
00032 
00033 namespace paludis
00034 {
00035     namespace args
00036     {
00037         /**
00038          * Convenience struct for --help handling.
00039          *
00040          * \ingroup g_args
00041          */
00042         struct PALUDIS_VISIBLE DoHelp
00043         {
00044             /**
00045              * Our message, if one is necessary.
00046              */
00047             const std::string message;
00048 
00049             ///\name Basic operations
00050             ///\{
00051 
00052             DoHelp(const std::string & m = "") :
00053                 message(m)
00054             {
00055             }
00056 
00057             ///\}
00058         };
00059     }
00060 }
00061 
00062 
00063 #endif

Generated on Mon Sep 21 10:36:08 2009 for paludis by  doxygen 1.5.4