add & delete object documentation

added add & delete object console method documentation.
This commit is contained in:
Nathan Bowhay 2015-02-02 16:07:15 -08:00
parent 72a0aed154
commit 1ce846d235

View file

@ -58,10 +58,12 @@ void MECreateUndoAction::addObject( SimObject *object )
mObjects.last().id = object->getId(); mObjects.last().id = object->getId();
} }
DefineConsoleMethod( MECreateUndoAction, addObject, void, (SimObject *obj), , "( SimObject obj )") DefineEngineMethod( MECreateUndoAction, addObject, void, ( SimObject* obj),,
"Add the object being created to an undo action.\n"
"@param obj Object being created you want to create the undo for.")
{ {
if (obj) if (obj)
object->addObject( obj ); object->addObject( obj );
} }
void MECreateUndoAction::undo() void MECreateUndoAction::undo()
@ -163,10 +165,12 @@ void MEDeleteUndoAction::deleteObject( const Vector<SimObject*> &objectList )
deleteObject( objectList[i] ); deleteObject( objectList[i] );
} }
DefineConsoleMethod( MEDeleteUndoAction, deleteObject, void, (SimObject *obj ), , "( SimObject obj )") DefineEngineMethod( MEDeleteUndoAction, deleteObject, void, ( SimObject* obj),,
"Delete the object and add it to the undo action.\n"
"@param obj Object to delete and add to the undo action.")
{ {
if (obj) if (obj)
object->deleteObject( obj ); object->deleteObject( obj );
} }
void MEDeleteUndoAction::undo() void MEDeleteUndoAction::undo()