1.1 --- a/public/IRootConsoleMenu.h	Thu Jan 25 22:39:12 2007 +0000
     1.2 +++ b/public/IRootConsoleMenu.h	Fri Jan 26 01:55:06 2007 +0000
     1.3 @@ -1,11 +1,29 @@
     1.4 +/**
     1.5 + * ===============================================================
     1.6 + * SourceMod (C)2004-2007 AlliedModders LLC.  All rights reserved.
     1.7 + * ===============================================================
     1.8 + *
     1.9 + *  This file is part of the SourceMod/SourcePawn SDK.  This file may only be used 
    1.10 + * or modified under the Terms and Conditions of its License Agreement, which is found 
    1.11 + * in LICENSE.txt.  The Terms and Conditions for making SourceMod extensions/plugins 
    1.12 + * may change at any time.  To view the latest information, see:
    1.13 + *   http://www.sourcemod.net/license.php
    1.14 + *
    1.15 + * Version: $Id$
    1.16 + */
    1.17 +
    1.18  #ifndef _INCLUDE_SOURCEMOD_ROOT_CONSOLE_MENU_H_
    1.19  #define _INCLUDE_SOURCEMOD_ROOT_CONSOLE_MENU_H_
    1.20  
    1.21  /**
    1.22 - * @brief Note: This interface is not exposed.
    1.23 - * The reason should be obvious: we do not want users touching the "root" console menu.
    1.24 - * If we exposed this, every little plugin would be dropping down a silly set of user commands,
    1.25 - * whereas this menu is explicitly provided for stuff that only Core itself is capable of managing.
    1.26 + * @file IRootConsoleMenu.h
    1.27 + * @brief Defines the interface for adding options to the "sm" console command.
    1.28 + *
    1.29 + *  This interface is not yet exported.  It will be eventually.  The initial reason should 
    1.30 + * be obvious: we do not want users actually touching it.  If we exposed this, every little 
    1.31 + * plugin would be dropping down a silly set of user commands, and exploiting/cluttering the menu.
    1.32 + * Since this menu is explicitly provided for stuff that only Core itself is capable of managing,
    1.33 + * we won't expose it until a legitimate reason comes up.
    1.34   */
    1.35  
    1.36  namespace SourceMod
    1.37 @@ -80,8 +98,8 @@
    1.38  		 * N being the length of the command name.  This is subject to change in case we
    1.39  		 * account for Valve's font choices.
    1.40  		 *
    1.41 -		 * @param option		String containing the command option.
    1.42 -		 * @param description	String containing the command description.
    1.43 +		 * @param cmd		String containing the command option.
    1.44 +		 * @param text		String containing the command description.
    1.45  		 */
    1.46  		virtual void DrawGenericOption(const char *cmd, const char *text) =0;
    1.47  	};