aboutsummaryrefslogtreecommitdiff
path: root/sword2/driver/language.cpp
diff options
context:
space:
mode:
Diffstat (limited to 'sword2/driver/language.cpp')
-rw-r--r--sword2/driver/language.cpp59
1 files changed, 21 insertions, 38 deletions
diff --git a/sword2/driver/language.cpp b/sword2/driver/language.cpp
index 81e63f4663..6ac4ec66f9 100644
--- a/sword2/driver/language.cpp
+++ b/sword2/driver/language.cpp
@@ -17,43 +17,6 @@
* $Header$
*/
-//=============================================================================
-//
-// Filename : language.c
-// Created : 20th August 1996
-// By : P.R.Porter
-//
-// Summary : This module holds the functions which govern which language
-// version is current.
-//
-// Functions
-// ---------
-//
-// --------------------------------------------------------------------------
-//
-// int32 GetLanguageVersion(uint8 *version)
-//
-// This function modifies the 'version' passed in to be the current language.
-// The first time this function is called, it gets the language from the
-// version.inf file distributed on the game CD. It returns an RD error code
-// if this file cannot be opened, or the version cannot be obtained from it.
-//
-// ---------------------------------------------------------------------------
-//
-// int32 SetLanguageVersion(uint8 version)
-//
-// This function is useful for debugging. It sets the version to the one
-// passed in.
-//
-// ---------------------------------------------------------------------------
-//
-// int32 GetGameName(uint8 *name);
-//
-// Fills the string pointed to by name with the title of the game, depending
-// upon what the current language version is.
-//
-//=============================================================================
-
#include "stdafx.h"
#include "driver96.h"
@@ -61,6 +24,15 @@ uint8 languageVersion = ENGLISH;
static uint8 versionFromFile = 0;
+/**
+ * This function modifies the 'version' passed in to be the current language.
+ * The first time this function is called, it gets the language from the
+ * version.inf file distributed on the game CD.
+ * @param version a pointer to the variable to store language information in
+ * @return an RD error code if version.inf cannot be opened, or the version
+ * cannot be obtained from it
+ */
+
int32 GetLanguageVersion(uint8 *version) {
if (versionFromFile) {
*version = languageVersion;
@@ -72,11 +44,22 @@ int32 GetLanguageVersion(uint8 *version) {
return RD_OK;
}
+/**
+ * This function is useful for debugging. It sets the version to the one passed
+ * in.
+ */
+
int32 SetLanguageVersion(uint8 version) {
languageVersion = version;
return RD_OK;
}
+/**
+ * Fills the string pointed to by 'name' with the title of the game, depending
+ * upon what the current language version is.
+ * @param name buffer to store the title of the game in
+ */
+
int32 GetGameName(uint8 *name) {
uint8 version;
int32 rv;
@@ -94,7 +77,7 @@ int32 GetGameName(uint8 *name) {
strcpy((char *) name, "Baphomet's Fluch II");
break;
default:
- strcpy((char *)name, "Some game or other, part 86");
+ strcpy((char *) name, "Some game or other, part 86");
return RDERR_INVALIDVERSION;
}