annotate LibModuleDBShare-1.0/LibModuleDBShare-1.0.lua @ 5:4366f51a7069
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 |
35159f132552 |
| rev |
line source |
|
>@5
|
1 --- **LibModuleDBShare-1.0**\\
|
|
>@5
|
2 -- A description will eventually be here.
|
|
>@5
|
3 --
|
|
>@5
|
4 -- @usage
|
|
>@5
|
5 -- Also coming soon.
|
|
>@5
|
6 -- @class file
|
|
>@5
|
7 -- @name LibModuleDBShare-1.0.lua
|
|
>@3
|
8 local MAJOR, MINOR = "LibModuleDBShare-1.0", 1
|
|
>@3
|
9 local LibModuleDBShare, oldminor = LibStub:NewLibrary(MAJOR, MINOR)
|
|
>@3
|
10
|
|
>@4
|
11 if not LibModuleDBShare then return end -- No upgrade needed
|
|
>@4
|
12
|
|
>@4
|
13 LibModuleDBShare.groups = LibModuleDBShare.groups or {};
|
|
>@4
|
14
|
|
>@5
|
15 local DBGroup = {};
|
|
>@5
|
16
|
|
>@5
|
17 --- Creates a new DB group.
|
|
>@5
|
18 -- @param groupName The name of the new DB group.
|
|
>@5
|
19 -- @param usesDualSpec True if this group should use LibDualSpec, false otherwise.
|
|
>@5
|
20 -- @usage
|
|
>@5
|
21 -- local myAddonDBGroup = LibStub("LibModuleDBShare-1.0"):NewGroup("MyAddonGroupName", true)
|
|
>@5
|
22 -- @return the new DB group object
|
|
>@4
|
23 function LibModuleDBShare:NewGroup(groupName, usesDualSpec)
|
|
>@4
|
24
|
|
>@4
|
25 end
|
|
>@4
|
26
|
|
>@5
|
27 --- Retrieves an existing DB group.
|
|
>@5
|
28 -- @param groupName The name of the DB group to retrieve.
|
|
>@5
|
29 -- @usage
|
|
>@5
|
30 -- local myAddonDBGroup = LibStub("LibModuleDBShare-1.0"):GetGroup("MyAddonGroupName")
|
|
>@5
|
31 -- @return the DB group object, or nil if not found
|
|
>@5
|
32 function LibModuleDBShare:GetGroup(groupName)
|
|
>@4
|
33
|
|
>@4
|
34 end
|
|
>@5
|
35
|
|
>@5
|
36 --- Adds a database to the group.
|
|
>@5
|
37 -- @param db The name of the new DB group.
|
|
>@5
|
38 -- @usage
|
|
>@5
|
39 -- myAddonDBGroup:AddDB(MyAddon.db)
|
|
>@5
|
40 function DBGroup:AddDB(db)
|
|
>@5
|
41
|
|
>@5
|
42 end
|
