org/sonews/daemon/command/HelpfulCommand.java
author cli
Tue Apr 27 21:51:12 2010 +0200 (2010-04-27)
changeset 26 407c428adb5b
permissions -rw-r--r--
Introduce more advanced help system (#565).
     1 /*
     2  *   SONEWS News Server
     3  *   see AUTHORS for the list of contributors
     4  *
     5  *   This program is free software: you can redistribute it and/or modify
     6  *   it under the terms of the GNU General Public License as published by
     7  *   the Free Software Foundation, either version 3 of the License, or
     8  *   (at your option) any later version.
     9  *
    10  *   This program is distributed in the hope that it will be useful,
    11  *   but WITHOUT ANY WARRANTY; without even the implied warranty of
    12  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    13  *   GNU General Public License for more details.
    14  *
    15  *   You should have received a copy of the GNU General Public License
    16  *   along with this program.  If not, see <http://www.gnu.org/licenses/>.
    17  */
    18 
    19 package org.sonews.daemon.command;
    20 
    21 /**
    22  *
    23  * @since sonews/1.1
    24  * @author Christian Lins
    25  */
    26 public interface HelpfulCommand extends Command
    27 {
    28 
    29   /**
    30    * @return A short description of this command, that is
    31    * used within the output of the HELP command.
    32    */
    33   String getHelpString();
    34 
    35 }