Skip to content
This repository has been archived by the owner on Jan 1, 2021. It is now read-only.

Commit

Permalink
Fix documentation typos, and expand entity.markClean/markDirty to war…
Browse files Browse the repository at this point in the history
…n off using them directly
  • Loading branch information
gravitystorm committed Dec 13, 2010
1 parent 90fcb51 commit 1455123
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions net/systemeD/halcyon/connection/Entity.as
Expand Up @@ -102,15 +102,15 @@ package net.systemeD.halcyon.connection {
return tags[key];
}

/** @return true iff there exists key=value */
/** @return true if there exists key=value */
public function tagIs(key:String,value:String):Boolean {
if (!tags[key]) { return false; }
return tags[key]==value;
}

/** Set key=value, with optional undoability.
* @param key Name of key to set
* @parame value Value to set tag to
* @param value Value to set tag to
* @param performAction Single-argument function to pass a SetTagAction to.
* @example setTag("highway", "residential", MainUndoStack.getGlobalStack().addAction);
*/
Expand Down Expand Up @@ -161,12 +161,12 @@ package net.systemeD.halcyon.connection {
return modified;
}

/** Reset modified flag. */
/** Reset modified flag. You should not be calling this directly, instead you should be calling markClean from your UndoableEntityAction */
public function markClean():void {
modified = false;
}

/** Set entity as modified. */
/** Set entity as modified. You should not be calling this directly, instead you should be calling markDirty from your UndoableEntityAction */
internal function markDirty():void {
modified = true;
}
Expand Down Expand Up @@ -195,7 +195,7 @@ package net.systemeD.halcyon.connection {
}
}

/** Whether entity is "empty" - to be overridden by subclass. */
/** Whether entity is "empty" - to be overridden by subclass. */
internal function isEmpty():Boolean {
return false;
}
Expand Down

0 comments on commit 1455123

Please sign in to comment.