Test using LuaDoc to generate documentation for conditions.
Johnny C. Lam [09-24-12 - 19:44]
Test using LuaDoc to generate documentation for conditions.
git-svn-id: svn://svn.curseforge.net/wow/ovale/mainline/trunk@555 d5049fe3-3747-40f7-a4b5-f36d6801af5f
diff --git a/.docmeta b/.docmeta
index d0e0dd7..31858b3 100644
--- a/.docmeta
+++ b/.docmeta
@@ -1,4 +1,8 @@
-
type: markdown
input-file: README.md
- output-page: main
\ No newline at end of file
+ output-page: Main
+-
+ type: luadoc
+ input-file: OvaleCondition.lua
+ output-page: Conditions
\ No newline at end of file
diff --git a/OvaleCondition.lua b/OvaleCondition.lua
index e5a1ae1..7cfb03a 100644
--- a/OvaleCondition.lua
+++ b/OvaleCondition.lua
@@ -420,9 +420,15 @@ OvaleCondition.conditions=
return 0.1
end
end,]]
- -- Get how many armor set parts are equiped by the player
- -- 1 : set name
- -- returns : bool or number
+ --- Get how many pieces of an armor set, e.g., Tier 14 set, are equipped by the player.
+ -- @name ArmorSetParts
+ -- @param setName The name of the armor set. Valid values are: T11, T12, T13.
+ -- @param operator (Optional) Comparison operator: equal, less, more.
+ -- @param number (Optional) The number to compare against.
+ -- @returns A number or a boolean value.
+ -- @usage
+ -- if ArmorSetParts(T13) >=2 and target.HealthPercent() <60 Spell(ferocious_bite)
+ -- if ArmorSetParts(T13 more 1) and TargetHealthPercent(less 60) Spell(ferocious_bite)
armorsetparts = function(condition)
local nombre = 0
if OvaleEquipement.nombre[condition[1]] then