Mercurial > wow > libmoduledbshare-1-0

changeset 5:4366f51a7069

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
added .docmeta file. added luadoc to LibModuleDBShare-1.0.lua. completed initial function stubs. back to auto change log.
author Thnan <>
date Sat, 09 Mar 2013 02:26:13 -0500
parents 6ea3069a629f
children a01eef6c0c22
files .docmeta .pkgmeta LibModuleDBShare-1.0/LibModuleDBShare-1.0.lua
diffstat 3 files changed, 33 insertions(+), 3 deletions(-) [+]
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/.docmeta	Sat Mar 09 02:26:13 2013 -0500
@@ -0,0 +1,4 @@
+
+type: luadoc
+input-files: "LibModuleDBShare-1.0/LibModuleDBShare-1.0.lua
+output-page: "API"
--- a/.pkgmeta	Fri Mar 08 11:43:10 2013 -0500
+++ b/.pkgmeta	Sat Mar 09 02:26:13 2013 -0500
@@ -3,8 +3,6 @@
 
 license-output: LibModuleDBShare-1.0/License.txt
 
-manual-changelog: Changelog.txt
-
 enable-nolib-creation: no
 
 tools-used:
--- a/LibModuleDBShare-1.0/LibModuleDBShare-1.0.lua	Fri Mar 08 11:43:10 2013 -0500
+++ b/LibModuleDBShare-1.0/LibModuleDBShare-1.0.lua	Sat Mar 09 02:26:13 2013 -0500
@@ -1,3 +1,10 @@
+--- **LibModuleDBShare-1.0**\\ 
+-- A description will eventually be here.
+--
+-- @usage
+-- Also coming soon.
+-- @class file
+-- @name LibModuleDBShare-1.0.lua
 local MAJOR, MINOR = "LibModuleDBShare-1.0", 1
 local LibModuleDBShare, oldminor = LibStub:NewLibrary(MAJOR, MINOR)
 
@@ -5,10 +12,31 @@
 
 LibModuleDBShare.groups = LibModuleDBShare.groups or {};
 
+local DBGroup = {};
+
+--- Creates a new DB group.
+-- @param groupName The name of the new DB group.
+-- @param usesDualSpec True if this group should use LibDualSpec, false otherwise.
+-- @usage
+-- local myAddonDBGroup = LibStub("LibModuleDBShare-1.0"):NewGroup("MyAddonGroupName", true)
+-- @return the new DB group object
 function LibModuleDBShare:NewGroup(groupName, usesDualSpec)
 	
 end
 
-function LibModuleDBShare:AddModule(groupName, db)
+--- Retrieves an existing DB group.
+-- @param groupName The name of the DB group to retrieve.
+-- @usage
+-- local myAddonDBGroup = LibStub("LibModuleDBShare-1.0"):GetGroup("MyAddonGroupName")
+-- @return the DB group object, or nil if not found
+function LibModuleDBShare:GetGroup(groupName)
 
 end
+
+--- Adds a database to the group.
+-- @param db The name of the new DB group.
+-- @usage
+-- myAddonDBGroup:AddDB(MyAddon.db)
+function DBGroup:AddDB(db)
+
+end