ENGINES: Return all available custom GUI options if no target is specified

This is used to set default settings for all custom game options when an
engine starts

1 files changed, 8 insertions, 1 deletions

diff --git a/engines/metaengine.h b/engines/metaengine.h
index 632c204978..ffa682fc53 100644
--- a/engines/metaengine.h
+++ b/engines/metaengine.h
@@ -112,10 +112,17 @@ public:
 	}
 
 	/**
-	 * Return a list of extra GUI options.
+	 * Return a list of extra GUI options for the specified target.
+	 * If no target is specified, all of the available custom GUI options are
+	 * Returned for the plugin (used to set default values).
+	 *
 	 * Currently, this only supports options with checkboxes.
 	 *
 	 * The default implementation returns an empty list.
+	 *
+	 * @param target    name of a config manager target
+	 * @return          a list of extra GUI options for an engine plugin and
+	 *                  target
 	 */
 	virtual const ExtraGuiOptions getExtraGuiOptions(const Common::String &target) const {
 		return ExtraGuiOptions();