Skip to content

Commit f30f955

Browse files
committed
Update doxy on ship_cleanup to reference the object cleanup path
1 parent 73504f8 commit f30f955

File tree

1 file changed

+2
-1
lines changed

1 file changed

+2
-1
lines changed

code/ship/ship.h

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1386,9 +1386,10 @@ extern int ship_get_num_ships();
13861386
* @param[in] cleanup_mode Flags describing how this ship is to be removed. See SHIP_VANISHED, SHIP_DESTROYED, etc.
13871387
*
13881388
* @details This is the deconstructor of a ship, it does all the necassary processes to remove the ship from the Ships
1389-
* array, and frees the slot for use by others. De-init of its Objects[] slot is handled elsewhere.
1389+
* array, and frees the slot for use by others. De-init of its Objects[] slot is handled by obj_delete_all_that_should_be_dead().
13901390
*
13911391
* @author Goober5000
1392+
* @sa obj_delete_all_that_should_be_dead()
13921393
*/
13931394
extern void ship_cleanup(int shipnum, int cleanup_mode);
13941395

0 commit comments

Comments
 (0)