Added some more comments
authorDavid Anderson <dvander@alliedmods.net>
Tue Apr 19 17:27:05 2005 +0000 (2005-04-19)
changeset 30b36f706275e4
parent 29 10e6dc40505e
child 31 543ffb5f4908
Added some more comments
sourcemm/ISmmPlugin.h
     1.1 --- a/sourcemm/ISmmPlugin.h	Tue Apr 19 07:41:07 2005 +0000
     1.2 +++ b/sourcemm/ISmmPlugin.h	Tue Apr 19 17:27:05 2005 +0000
     1.3 @@ -51,7 +51,7 @@
     1.4  	 */
     1.5  	virtual bool Load(PluginId id, ISmmAPI *ismm, factories *list, char *error, size_t maxlen) =0;
     1.6  
     1.7 -	/* @brief Called on plugin unload.
     1.8 +	/** @brief Called on plugin unload.
     1.9  	 *
    1.10  	 * @param error Error message buffer
    1.11  	 * @param maxlen Size of error message buffer
    1.12 @@ -59,7 +59,7 @@
    1.13  	 */
    1.14  	virtual bool Unload(char *error, size_t maxlen) =0;
    1.15  
    1.16 -	/* @brief Called on plugin pause.
    1.17 +	/** @brief Called on plugin pause.
    1.18  	 *
    1.19  	 * @param error Error message buffer
    1.20  	 * @param maxlen Size of error message buffer
    1.21 @@ -67,7 +67,7 @@
    1.22  	 */
    1.23  	virtual bool Pause(char *error, size_t maxlen) =0;
    1.24  
    1.25 -	/* @brief Called on plugin unpause.
    1.26 +	/** @brief Called on plugin unpause.
    1.27  	 *
    1.28  	 * @param error Error message buffer
    1.29  	 * @param maxlen Size of error message buffer
    1.30 @@ -75,17 +75,34 @@
    1.31  	 */
    1.32  	virtual bool Unpause(char *error, size_t maxlen) =0;
    1.33  public:
    1.34 +	/** @brief Return author as string */
    1.35  	virtual const char *GetAuthor() =0;
    1.36 +
    1.37 +	/** @brief Return plugin name as string */
    1.38  	virtual const char *GetName() =0;
    1.39 +
    1.40 +	/** @brief Return a description as string */
    1.41  	virtual const char *GetDescription() =0;
    1.42 +
    1.43 +	/** @brief Return a URL as string */
    1.44  	virtual const char *GetURL() =0;
    1.45 +
    1.46 +	/** @brief Return quick license code as string */
    1.47  	virtual const char *GetLicense() =0;
    1.48 +
    1.49 +	/** @brief Return version as string */
    1.50  	virtual const char *GetVersion() =0;
    1.51 +
    1.52 +	/** @brief Return author as string */
    1.53  	virtual const char *GetDate() =0;
    1.54 +
    1.55 +	/** @brief Return author as string */
    1.56  	virtual const char *GetLogTag() =0;
    1.57  public:
    1.58  	/**
    1.59  	 * @brief Called when all plugins have been loaded - API version 4
    1.60 +         *
    1.61 +         * Ths is useful for knowing when it's safe to request things another plugin might have.
    1.62  	 */
    1.63  	virtual void AllPluginsLoaded() =0;
    1.64  };