Document ValueOf requirement

DenizenScript · Dec 9, 2013 · 1bb84d7 · 1bb84d7
1 parent 54a4408
commit 1bb84d7
Showing 1 changed file with 19 additions and 0 deletions.
diff --git a/src/main/java/net/aufdemrand/denizen/scripts/requirements/RequirementChecker.java b/src/main/java/net/aufdemrand/denizen/scripts/requirements/RequirementChecker.java
@@ -73,6 +73,25 @@ public boolean check(RequirementsContext context) {
             //
             // Evaluate the requirement
             //
+
+            // <--[requirement]
+            // @Name ValueOf
+            // @Syntax valueof [<tag>]
+            // @Required 1
+            // @Stable stable
+            // @Short Checks if the tag is true.
+            //
+            // @Description
+            // Checks if a specified tag or value of some sort returns "true".
+            //
+            // @Usage
+            // Check if a simple tag is true.
+            // - valueof <player.is_player>
+            //
+            // @Usage
+            // Check a comparator (See <@link language operator> for more information...)
+            // - valueof <player.health.is[LESS].than[10]>
+            // -->
             if (reqString.equalsIgnoreCase("valueof")) {
                 String arg = argumentList.get(1);