From fc79b00ff2ad09b343a49d8acfccb26911510b0e Mon Sep 17 00:00:00 2001 From: "Johnny C. Lam" Date: Mon, 24 Sep 2012 20:35:39 +0000 Subject: [PATCH] Settle on template for LuaDoc commenting of conditions. Use the following tags: @name ConditionName @paramsig @param param1 Description of first parameter. @param param2 Description of second parameter. @return Description of returned value. @usage Example uses of the condition in a script. git-svn-id: svn://svn.curseforge.net/wow/ovale/mainline/trunk@562 d5049fe3-3747-40f7-a4b5-f36d6801af5f --- OvaleCondition.lua | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/OvaleCondition.lua b/OvaleCondition.lua index 00f3124..7ea1717 100644 --- a/OvaleCondition.lua +++ b/OvaleCondition.lua @@ -421,11 +421,12 @@ OvaleCondition.conditions= end end,]] --- Get how many pieces of an armor set, e.g., Tier 14 set, are equipped by the player. --- @paramsig setName [operator number] +-- @name ArmorSetParts +-- @paramsig -- @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. +-- @return A number or a boolean value. -- @usage -- if ArmorSetParts(T13) >=2 and target.HealthPercent() <60 -- Spell(ferocious_bite) -- 1.7.9.5