do_help.hh

Go to the documentation of this file.

/* vim: set sw=4 sts=4 et foldmethod=syntax : */
 
/*
 * Copyright (c) 2006, 2007, 2011 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.
 */
 
#include <paludis/util/attributes.hh>
#include <string>
 
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