Update OnLibraryAdded and OnLibraryRemoved docs (#1303)

`OnLibraryAdded` and `OnLibraryRemoved` are called whether or not a optional dependency exists
This commit is contained in:
Impact 2020-07-09 11:09:59 +02:00 committed by GitHub
parent 4e0ae0cb5e
commit a065773b6d
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -452,7 +452,7 @@ native void RegPluginLibrary(const char[] name);
* Returns whether a library exists. This function should be considered * Returns whether a library exists. This function should be considered
* expensive; it should only be called on plugin to determine availability * expensive; it should only be called on plugin to determine availability
* of resources. Use OnLibraryAdded()/OnLibraryRemoved() to detect changes * of resources. Use OnLibraryAdded()/OnLibraryRemoved() to detect changes
* in optional resources. * in libraries.
* *
* @param name Library name of a plugin or extension. * @param name Library name of a plugin or extension.
* @return True if exists, false otherwise. * @return True if exists, false otherwise.
@ -473,8 +473,8 @@ native bool LibraryExists(const char[] name);
native int GetExtensionFileStatus(const char[] name, char[] error="", int maxlength=0); native int GetExtensionFileStatus(const char[] name, char[] error="", int maxlength=0);
/** /**
* Called after a library is added that the current plugin references * Called after a library is added.
* optionally. A library is either a plugin name or extension name, as * A library is either a plugin name or extension name, as
* exposed via its include file. * exposed via its include file.
* *
* @param name Library name. * @param name Library name.
@ -482,8 +482,8 @@ native int GetExtensionFileStatus(const char[] name, char[] error="", int maxlen
forward void OnLibraryAdded(const char[] name); forward void OnLibraryAdded(const char[] name);
/** /**
* Called right before a library is removed that the current plugin references * Called right before a library is removed.
* optionally. A library is either a plugin name or extension name, as * A library is either a plugin name or extension name, as
* exposed via its include file. * exposed via its include file.
* *
* @param name Library name. * @param name Library name.