Browse Source

Garrison: Documentation for our() and ally()

Sandy Carter 10 years ago
parent
commit
6ffb03cba3
1 changed files with 2 additions and 0 deletions
  1. 2 0
      client/widgets/CGarrisonInt.cpp

+ 2 - 0
client/widgets/CGarrisonInt.cpp

@@ -122,11 +122,13 @@ const CArmedInstance * CGarrisonSlot::getObj() const
 	return 	(!upg)?(owner->armedObjs[0]):(owner->armedObjs[1]);
 }
 
+/// @return Whether the unit in the slot belongs to the current player.
 bool CGarrisonSlot::our() const
 {
 	return 	upg?(owner->owned[1]):(owner->owned[0]);
 }
 
+/// @return Whether the unit in the slot belongs to an ally but not to the current player.
 bool CGarrisonSlot::ally() const
 {
 	if(!getObj())