AVALANCHE: Add some doxygen comments in Lucerna

2 files changed, 28 insertions, 11 deletions

diff --git a/engines/avalanche/lucerna2.cpp b/engines/avalanche/lucerna2.cpp
index 5782ac9497..2ec32b2ca0 100644
--- a/engines/avalanche/lucerna2.cpp
+++ b/engines/avalanche/lucerna2.cpp
@@ -177,6 +177,10 @@ void Lucerna::drawAlsoLines() {
 
 // readAlsoStringFromFile, scram and unScramble are only used in loadAlso
 
+/**
+ * Check is it's possible to give something to Spludwick
+ * @remarks	Originally called 'nextstring'
+ */
 Common::String Lucerna::readAlsoStringFromFile() {
 	Common::String str;
 	byte length = file.readByte();
@@ -367,6 +371,12 @@ void Lucerna::exitRoom(byte x) {
 		_vm->_gyro->_dna._lastRoomNotMap = _vm->_gyro->_dna._room;
 }
 
+
+/**
+ * Only when entering a NEW town! Not returning to the last one,
+ * but choosing another from the map.
+ * @remarks	Originally called 'new_town'
+ */
 void Lucerna::enterNewTown() {
 	_vm->_dropdown->setupMenu();
 
@@ -1017,6 +1027,9 @@ void Lucerna::refreshObjectList() {
 	}
 }
 
+/**
+ * @remarks	Originally called 'verte'
+ */
 void Lucerna::guideAvvy(Common::Point cursorPos) {
 	if (!_vm->_gyro->_dna._userMovesAvvy)
 		return;
@@ -1226,6 +1239,13 @@ uint16 Lucerna::bearing(byte whichPed) {
 	}
 }
 
+/** 
+ * A sprite run is performed before displaying a scroll, if not all the
+ * sprites are still. It performs two fast cycles, only using a few of
+ * the links usually used, and without any extra animation. This should
+ * make the sprites the same on both pages.
+ * @remarks	Originally called 'sprite_run'
+ */
 void Lucerna::spriteRun() {
 	_vm->_gyro->_doingSpriteRun = true;
 	_vm->_animation->animLink();
diff --git a/engines/avalanche/lucerna2.h b/engines/avalanche/lucerna2.h
index ad0e4a2a98..9c1cc6ce44 100644
--- a/engines/avalanche/lucerna2.h
+++ b/engines/avalanche/lucerna2.h
@@ -48,14 +48,13 @@ private:
 
 	AvalancheEngine *_vm;
 
-	uint16 _hour, _minute, _second, _hourAngle, _oldHour, _oldMinute, _oldHourAngle; // hourAngle = nh in the original.
-	Common::Point _clockHandHour, _clockHandMinute; // ah and am in the original.
+	uint16 _hour, _minute, _second, _hourAngle, _oldHour, _oldMinute, _oldHourAngle;
+	Common::Point _clockHandHour, _clockHandMinute;
 
 	void calcHand(uint16 angle, uint16 length, Common::Point &endPoint, byte color);
 	void drawHand(const Common::Point &endPoint, byte color);
 	void plotHands();
 	void chime();
-
 };
 
 class Lucerna {
@@ -94,28 +93,26 @@ public:
 	void minorRedraw();
 	void majorRedraw();
 
-	// A sprite run is performed before displaying a scroll, if not all the sprites are still. It performs two fast cycles, only using a few of
-	// the links usually used, and without any extra animation. This should make the sprites the same on both pages.
 	void spriteRun();
 
 private:
 	AvalancheEngine *_vm;
 
-	bool _fxHidden; // Will de used in dusk() and dawn().
-
 	Common::File file;
 
-	Common::String readAlsoStringFromFile(); // 'nexstring' in the original.
+	Common::String readAlsoStringFromFile();
 	void scram(Common::String &str);
 	void unScramble();
 
 	void zoomOut(int16 x, int16 y); // Only used when entering the map.
-	void enterNewTown(); // Onyl when entering a NEW town! Not returning to the last one, but choosing another from the map.
+	void enterNewTown();
 	void findPeople(byte room);
 	void putGeidaAt(byte whichPed, byte &ped);
-	void guideAvvy(Common::Point cursorPos); // 'verte' in the original.
+	void guideAvvy(Common::Point cursorPos);
+
+	// Will be used in dusk() and dawn().
+	bool _fxHidden;
 
-	// Used in dusk() and dawn().
 	int8 fades(int8 x);
 	void fadeOut(byte n);
 	void fadeIn(byte n);