cpp/openttd-patchpack/source Changeset - r20945:d3a94ec942ba

Changeset - r20945:d3a94ec942ba

Parent rev.

Child rev.

[Not reviewed]

master

0 2 0

zuu - 11 years ago 2013-11-16 12:33:45
zuu@openttd.org

(svn r26010) -Document [FS#5662]: The AI/GS library name to use in Import, is not the name given by GetName but GetInstanceName

2 files changed with 10 insertions and 5 deletions:

src/script/api/script_controller.hpp

src/script/api/script_info_docs.hpp

0 comments (0 inline, 0 general)

src/script/api/script_controller.hpp

➞

Show inline comments

@@ @@ -127,7 +127,8 @@ public: @@
 	/**
 	 * Import a library.
 	 * @param library The name of the library to import.
 	 * @param library The name of the library to import. The name should be composed as ScriptInfo::GetCategory() + "." +
 	 * ScriptInfo::CreateInstance().
 	 * @param class_name Under which name you want it to be available (or "" if you just want the returning object).
 	 * @param version Which version you want specifically.
 	 * @return The loaded library object. If class_name is set, it is also available (under the scope of the import) under that name.

src/script/api/script_info_docs.hpp

➞

Show inline comments

@@ @@ -18,9 +18,10 @@ @@
  *       Scripts must or can implemented to provide information to OpenTTD to
  *       base configuring/starting/loading the Script on.
+ *
  * @note The required functions are also needed for Script Libraries. As such
  *       the information here can be used for libraries, but the information
  *       will not be shown in the GUI except for error/debug messages.
  * @note The required functions are also needed for Script Libraries, but in
  *       that case you extend ScriptLibrary. As such the information here can
  *       be used for libraries, but the information will not be shown in the
  *       GUI except for error/debug messages.
+ *
  * @api ai game
  */
@@ @@ -43,6 +44,8 @@ public: @@
+	 *
 	 * @return The name of the Script.
 	 * @note This function is required.
 	 * @note This name is not used as library name by ScriptController::Import,
 	 * instead the name returned by #CreateInstance is used.
 	 */
 	string GetName();
@@ @@ -144,7 +147,8 @@ public: @@
 	/**
 	 * Gets the name of main class of the Script so OpenTTD knows
 	 * what class to instantiate.
 	 * what class to instantiate. For libraries, this name is also
 	 * used when other scripts import it using @ScriptController::Import.
+	 *
 	 * @return The class name of the Script.
 	 * @note This function is required.

0 comments (0 inline, 0 general)