Skip to content

Commit b7a9a52

Browse files
CauselessCauseless
authored
Merge pull request #58 from cortex-command-community/docformatting
Fix leftover old doc comments
2 parents bb8ba34 + f4da420 commit b7a9a52

34 files changed

+98
-562
lines changed

‎Source/Activities/GAScripted.cpp

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -314,12 +314,6 @@ void GAScripted::End() {
314314
}
315315

316316
/*
317-
//////////////////////////////////////////////////////////////////////////////////////////
318-
// Method: UpdateEditing
319-
//////////////////////////////////////////////////////////////////////////////////////////
320-
// Description: This is a special update step for when any player is still editing the
321-
// scene.
322-
323317
void GAScripted::UpdateEditing() {
324318
GameActivity::UpdateEditing();
325319
}

‎Source/Activities/GATutorial.cpp

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -348,12 +348,6 @@ void GATutorial::End() {
348348
}
349349

350350
/*
351-
//////////////////////////////////////////////////////////////////////////////////////////
352-
// Method: UpdateEditing
353-
//////////////////////////////////////////////////////////////////////////////////////////
354-
// Description: This is a special update step for when any player is still editing the
355-
// scene.
356-
357351
void GATutorial::UpdateEditing()
358352
{
359353
GameActivity::UpdateEditing();

‎Source/Activities/GameActivity.h

Lines changed: 0 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -395,68 +395,32 @@ namespace RTE {
395395
/// Return value: None.
396396
void SetRequireClearPathToOrbit(bool newvalue) { m_RequireClearPathToOrbit = newvalue; }
397397

398-
/// Method:
399-
/// Description:
400-
/// Return value:
401398
int GetDefaultFogOfWar() const { return m_DefaultFogOfWar; }
402399

403-
/// Method:
404-
/// Description:
405-
/// Return value:
406400
int GetDefaultRequireClearPathToOrbit() const { return m_DefaultRequireClearPathToOrbit; }
407401

408-
/// Method:
409-
/// Description:
410-
/// Return value:
411402
int GetDefaultDeployUnits() const { return m_DefaultDeployUnits; }
412403

413-
/// Method:
414-
/// Description:
415-
/// Return value:
416404
int GetDefaultGoldCakeDifficulty() const { return m_DefaultGoldCakeDifficulty; }
417405

418-
/// Method:
419-
/// Description:
420-
/// Return value:
421406
int GetDefaultGoldEasyDifficulty() const { return m_DefaultGoldEasyDifficulty; }
422407

423-
/// Method:
424-
/// Description:
425-
/// Return value:
426408
int GetDefaultGoldMediumDifficulty() const { return m_DefaultGoldMediumDifficulty; }
427409

428-
/// Method:
429-
/// Description:
430-
/// Return value:
431410
int GetDefaultGoldHardDifficulty() const { return m_DefaultGoldHardDifficulty; }
432411

433-
/// Method:
434-
/// Description:
435-
/// Return value:
436412
int GetDefaultGoldNutsDifficulty() const { return m_DefaultGoldNutsDifficulty; }
437413

438414
/// Gets the default gold for max difficulty.
439415
/// @return The default gold for max difficulty.
440416
int GetDefaultGoldMaxDifficulty() const { return m_DefaultGoldMaxDifficulty; }
441417

442-
/// Method:
443-
/// Description:
444-
/// Return value:
445418
bool GetFogOfWarSwitchEnabled() const { return m_FogOfWarSwitchEnabled; }
446419

447-
/// Method:
448-
/// Description:
449-
/// Return value:
450420
bool GetDeployUnitsSwitchEnabled() const { return m_DeployUnitsSwitchEnabled; }
451421

452-
/// Method:
453-
/// Description:
454-
/// Return value:
455422
bool GetGoldSwitchEnabled() const { return m_GoldSwitchEnabled; }
456423

457-
/// Method:
458-
/// Description:
459-
/// Return value:
460424
bool GetRequireClearPathToOrbitSwitchEnabled() const { return m_RequireClearPathToOrbitSwitchEnabled; }
461425

462426
/// Returns CrabToHumanSpawnRatio for specified module

‎Source/Activities/MultiplayerGame.cpp

Lines changed: 0 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -359,11 +359,6 @@ void MultiplayerGame::Update() {
359359
g_NetworkClient.Update();
360360
}
361361

362-
//////////////////////////////////////////////////////////////////////////////////////////
363-
// Method: DrawGUI
364-
//////////////////////////////////////////////////////////////////////////////////////////
365-
// Description: Draws the currently active GUI of a screen to a BITMAP of choice.
366-
367362
void MultiplayerGame::DrawGUI(BITMAP* pTargetBitmap, const Vector& targetPos, int which) {
368363
if (m_pGUIController) {
369364
AllegroScreen drawScreen(pTargetBitmap);
@@ -373,12 +368,6 @@ void MultiplayerGame::DrawGUI(BITMAP* pTargetBitmap, const Vector& targetPos, in
373368
}
374369
}
375370

376-
//////////////////////////////////////////////////////////////////////////////////////////
377-
// Method: Draw
378-
//////////////////////////////////////////////////////////////////////////////////////////
379-
// Description: Draws this MultiplayerGame's current graphical representation to a
380-
// BITMAP of choice. This includes all game-related graphics.
381-
382371
void MultiplayerGame::Draw(BITMAP* pTargetBitmap, const Vector& targetPos) {
383372
Activity::Draw(pTargetBitmap, targetPos);
384373
}

‎Source/Activities/MultiplayerServerLobby.cpp

Lines changed: 0 additions & 54 deletions
Original file line numberDiff line numberDiff line change
@@ -292,11 +292,6 @@ int MultiplayerServerLobby::Start() {
292292
return error;
293293
}
294294

295-
//////////////////////////////////////////////////////////////////////////////////////////
296-
// Method: UpdateActivityBox
297-
//////////////////////////////////////////////////////////////////////////////////////////
298-
// Description: Updates the contents of the Activity selection box.
299-
300295
void MultiplayerServerLobby::UpdateActivityBox() {
301296
// Get the currently selected Activity
302297
const Activity* pSelected = m_pActivitySelect->GetSelectedItem() ? dynamic_cast<const Activity*>(m_pActivitySelect->GetSelectedItem()->m_pEntity) : 0;
@@ -409,11 +404,6 @@ void MultiplayerServerLobby::UpdateDifficultySlider() {
409404
void MultiplayerServerLobby::UpdateSkillSlider() {
410405
}
411406

412-
//////////////////////////////////////////////////////////////////////////////////////////
413-
// Method: UpdatePlayersBox
414-
//////////////////////////////////////////////////////////////////////////////////////////
415-
// Description: Updates the contents of the player config box.
416-
417407
void MultiplayerServerLobby::UpdatePlayersBox(bool newActivity) {
418408
// Get the currently selected Activity
419409
const Activity* pActivity = m_pActivitySelect->GetSelectedItem() ? dynamic_cast<const Activity*>(m_pActivitySelect->GetSelectedItem()->m_pEntity) : 0;
@@ -719,11 +709,6 @@ void MultiplayerServerLobby::UpdatePlayersBox(bool newActivity) {
719709
}
720710
}
721711

722-
//////////////////////////////////////////////////////////////////////////////////////////
723-
// Method: PlayerCount
724-
//////////////////////////////////////////////////////////////////////////////////////////
725-
// Description: Counts how many players are currently assigned to play this Activity.
726-
727712
int MultiplayerServerLobby::PlayerCount() {
728713
int count = 0;
729714
// Go through all the on-team non-CPU cells and see how many players are already assigned.
@@ -736,13 +721,6 @@ int MultiplayerServerLobby::PlayerCount() {
736721
return count;
737722
}
738723

739-
//////////////////////////////////////////////////////////////////////////////////////////
740-
// Method: StartGame
741-
//////////////////////////////////////////////////////////////////////////////////////////
742-
// Description: Sets up and starts the currently selected Activity and settings.
743-
// Arguments: None.
744-
// Return value: None.
745-
746724
bool MultiplayerServerLobby::StartGame() {
747725
// Get the currently selected Activity
748726
const Activity* pActivityPreset = m_pActivitySelect->GetSelectedItem() ? dynamic_cast<const Activity*>(m_pActivitySelect->GetSelectedItem()->m_pEntity) : 0;
@@ -844,11 +822,6 @@ bool MultiplayerServerLobby::StartGame() {
844822
return /*m_ActivityRestarted = */ true;
845823
}
846824

847-
//////////////////////////////////////////////////////////////////////////////////////////
848-
// Method: GetAllScenesAndActivities
849-
//////////////////////////////////////////////////////////////////////////////////////////
850-
// Description: Gathers all the available Scene:s and Activity presets there are.
851-
852825
void MultiplayerServerLobby::GetAllScenesAndActivities() {
853826
// Redo the list of Activities
854827
m_Activities.clear();
@@ -921,34 +894,18 @@ void MultiplayerServerLobby::GetAllScenesAndActivities() {
921894
m_pSelectedScene = m_pScenes ? m_pScenes->front() : 0;
922895
}
923896

924-
//////////////////////////////////////////////////////////////////////////////////////////
925-
// Method: Pause
926-
//////////////////////////////////////////////////////////////////////////////////////////
927-
// Description: Pauses and unpauses the game.
928-
929897
void MultiplayerServerLobby::SetPaused(bool pause) {
930898
// Override the pause
931899
m_Paused = false;
932900
}
933901

934-
//////////////////////////////////////////////////////////////////////////////////////////
935-
// Method: End
936-
//////////////////////////////////////////////////////////////////////////////////////////
937-
// Description: Forces the current game's end.
938-
939902
void MultiplayerServerLobby::End() {
940903
Activity::End();
941904

942905
m_ActivityState = ActivityState::Over;
943906
g_FrameMan.SetDrawNetworkBackBuffer(false);
944907
}
945908

946-
//////////////////////////////////////////////////////////////////////////////////////////
947-
// Method: Update
948-
//////////////////////////////////////////////////////////////////////////////////////////
949-
// Description: Updates the state of this MultiplayerServerLobby. Supposed to be done every frame
950-
// before drawing.
951-
952909
void MultiplayerServerLobby::Update() {
953910
Activity::Update();
954911

@@ -1080,11 +1037,6 @@ void MultiplayerServerLobby::UpdateInput() {
10801037
}
10811038
}
10821039

1083-
//////////////////////////////////////////////////////////////////////////////////////////
1084-
// Method: DrawGUI
1085-
//////////////////////////////////////////////////////////////////////////////////////////
1086-
// Description: Draws the currently active GUI of a screen to a BITMAP of choice.
1087-
10881040
void MultiplayerServerLobby::DrawGUI(BITMAP* pTargetBitmap, const Vector& targetPos, int which) {
10891041
if (!m_pGUIController)
10901042
return;
@@ -1191,12 +1143,6 @@ void MultiplayerServerLobby::DrawGUI(BITMAP* pTargetBitmap, const Vector& target
11911143
}
11921144
}
11931145

1194-
//////////////////////////////////////////////////////////////////////////////////////////
1195-
// Method: Draw
1196-
//////////////////////////////////////////////////////////////////////////////////////////
1197-
// Description: Draws this MultiplayerServerLobby's current graphical representation to a
1198-
// BITMAP of choice. This includes all game-related graphics.
1199-
12001146
void MultiplayerServerLobby::Draw(BITMAP* pTargetBitmap, const Vector& targetPos) {
12011147
Activity::Draw(pTargetBitmap, targetPos);
12021148
}

‎Source/Entities/ACDropShip.h

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,6 @@ namespace RTE {
7474
/// Update called prior to controller update. Ugly hack. Supposed to be done every frame.
7575
void PreControllerUpdate() override;
7676

77-
/// Virtual method: GetMaxPassengers
7877
/// The recomended, not absolute, maximum number of actors that fit in the
7978
/// invetory. Used by the activity AI.
8079
/// @return An integer with the recomended number of actors that fit in the craft.

‎Source/Entities/ACRocket.h

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -90,7 +90,6 @@ namespace RTE {
9090
/// indicator arrows or hovering HUD text and so on.
9191
void Draw(BITMAP* pTargetBitmap, const Vector& targetPos = Vector(), DrawMode mode = g_DrawColor, bool onlyPhysical = false) const override;
9292

93-
/// Virtual method: GetMaxPassengers
9493
/// The recomended, not absolute, maximum number of actors that fit in the
9594
/// invetory. Used by the activity AI.
9695
/// @return An integer with the recomended number of actors that fit in the craft.
@@ -153,7 +152,6 @@ namespace RTE {
153152
/// @param newThruster The new thruster to use.
154153
void SetULeftThruster(AEmitter* newThruster);
155154

156-
/// Method: GetGearState
157155
/// Gets the the landing gear state
158156
/// @return Current landing gear state.
159157
unsigned int GetGearState() const { return m_GearState; }

‎Source/Entities/ACrab.cpp

Lines changed: 0 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -113,11 +113,6 @@ int ACrab::Create() {
113113
}
114114

115115
/*
116-
//////////////////////////////////////////////////////////////////////////////////////////
117-
// Method: Create
118-
//////////////////////////////////////////////////////////////////////////////////////////
119-
// Description: Makes the ACrab object ready for use.
120-
121116
int ACrab::Create(BITMAP *pSprite,
122117
Controller *pController,
123118
const float mass,
@@ -408,12 +403,6 @@ void ACrab::Destroy(bool notInherited) {
408403
}
409404

410405
/*
411-
//////////////////////////////////////////////////////////////////////////////////////////
412-
// Method: GetTotalValue
413-
//////////////////////////////////////////////////////////////////////////////////////////
414-
// Description: Gets the total liquidation value of this Actor and all its carried
415-
// gold and inventory.
416-
417406
float ACrab::GetTotalValue(int nativeModule, float foreignMult) const
418407
{
419408
float totalValue = Actor::GetTotalValue(nativeModule, foreignMult);
@@ -422,11 +411,6 @@ float ACrab::GetTotalValue(int nativeModule, float foreignMult) const
422411
}
423412
*/
424413
/*
425-
//////////////////////////////////////////////////////////////////////////////////////////
426-
// Virtual method: GetCPUPos
427-
//////////////////////////////////////////////////////////////////////////////////////////
428-
// Description: Gets the absoltue position of this' brain, or equivalent.
429-
430414
Vector ACrab::GetCPUPos() const
431415
{
432416
if (m_pTurret && m_pTurret->IsAttached() && m_pTurret->GetMountedMO())
@@ -621,26 +605,12 @@ bool ACrab::CollideAtPoint(HitData& hd) {
621605
}
622606

623607
/*
624-
//////////////////////////////////////////////////////////////////////////////////////////
625-
// Method: OnBounce
626-
//////////////////////////////////////////////////////////////////////////////////////////
627-
// Description: Defines what should happen when this MovableObject hits and then
628-
// bounces off of something. This is called by the owned Atom/AtomGroup
629-
// of this MovableObject during travel.
630-
631608
bool ACrab::OnBounce(const Vector &pos)
632609
{
633610
return false;
634611
}
635612
636613
637-
//////////////////////////////////////////////////////////////////////////////////////////
638-
// Method: OnSink
639-
//////////////////////////////////////////////////////////////////////////////////////////
640-
// Description: Defines what should happen when this MovableObject hits and then
641-
// sink into something. This is called by the owned Atom/AtomGroup
642-
// of this MovableObject during travel.
643-
644614
bool ACrab::OnSink(const Vector &pos)
645615
{
646616
return false;

‎Source/Entities/ACraft.h

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -254,14 +254,12 @@ namespace RTE {
254254
/// get drawn etc.
255255
void DrawHUD(BITMAP* pTargetBitmap, const Vector& targetPos = Vector(), int whichScreen = 0, bool playerControlled = false) override;
256256

257-
/// Virtual method: GetMaxPassengers
258257
/// The recomended, not absolute, maximum number of actors that fit in the
259258
/// invetory. Used by the activity AI.
260259
/// @return An integer with the recomended number of actors that fit in the craft.
261260
/// Default is -1 (unknown).
262261
virtual int GetMaxPassengers() const { return m_MaxPassengers; }
263262

264-
/// Virtual method: SetMaxPassengers
265263
/// Sets the recomended, not absolute, maximum number of actors that fit in the
266264
/// invetory. Used by the activity AI.
267265
/// @param max An integer with the recomended number of actors that fit in the craft.

0 commit comments

Comments
 (0)