Quantcast

More doc updates

ackis [04-06-09 - 18:29]
More doc updates
Filename
AckisRecipeList.lua
diff --git a/AckisRecipeList.lua b/AckisRecipeList.lua
index 4258760..0ac3aba 100644
--- a/AckisRecipeList.lua
+++ b/AckisRecipeList.lua
@@ -4,8 +4,8 @@

 AckisRecipeList.lua

-File date: @file-date-iso@
-File revision: @file-revision@
+File date: @file-date-iso@
+File revision: @file-revision@
 Project revision: @project-revision@
 Project version: @project-version@

@@ -25,6 +25,12 @@ Documentation:

 --]]

+--- **AckisRecipeList** provides an interface for scanning professions for missing recipes.
+-- There are a set of functions which allow you make use of the ARL database outside of ARL.
+-- @class file
+-- @name AckisRecipeList.lua
+-- @release @file-revision@
+
 local MODNAME	= "Ackis Recipe List"

 AckisRecipeList = LibStub("AceAddon-3.0"):NewAddon(MODNAME, "AceConsole-3.0", "AceEvent-3.0")
@@ -561,10 +567,10 @@ end
 --- Adds a tradeskill recipe into the specified recipe database.
 -- @name AckisRecipeList:addTradeSkill
 -- @usage AckisRecipeList:addTradeSkill(RecipeDB,2329,1,2454,1,2259)
--- @param textdump RecipeDB The database (array) which you wish to add data too.
--- @param SpellID
--- @param SkillLevel
--- @param ItemID
+-- @param RecipeDB RecipeDB The database (array) which you wish to add data too.
+-- @param SpellID The spell ID of the recipe being added to the database.
+-- @param SkillLevel The skill level at which the recipe may be learned.
+-- @param ItemID The item ID
 -- @param Rarity
 -- @param Profession
 -- @param Speciality