Skip to content

Commit e16cd89

Browse files
authored
Merge pull request #106 from LiliaFramework/codex/fill-out-meta.md,-hooks.md,-and-libraries.md
Standardize documentation headers
2 parents 3e17406 + a6c6852 commit e16cd89

File tree

66 files changed

+204
-10
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

66 files changed

+204
-10
lines changed

advert/docs/hooks.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# Hooks
2+
Module-specific events raised by the Advert module.
23

4+
---
35
### `AdvertSent`
46

57
**Purpose**
@@ -23,3 +25,4 @@ hook.Add("AdvertSent", "LogAdvert", function(client, message)
2325
print(client:Nick() .. " advertised: " .. message)
2426
end)
2527
```
28+
---

alcoholism/docs/hooks.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# Hooks
2+
Module-specific events raised by the Alcoholism module.
23

4+
---
35
### `BACChanged`
46

57
**Purpose**
@@ -256,3 +258,4 @@ hook.Add("PostBACDecrease", "NotifyDrop", function(client, newBac)
256258
end)
257259
```
258260

261+
---

alcoholism/docs/meta.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,8 @@
1-
# Meta
1+
# Player Meta
22

3+
Helper functions for tracking a player's blood alcohol content.
4+
5+
---
36
### Player:ResetBAC (Server)
47

58
**Purpose**
@@ -95,3 +98,4 @@ Shared
9598
```lua
9699
local level = client:GetBAC()
97100
```
101+
---

autorestarter/docs/hooks.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# Hooks
2+
Module-specific events raised by the Autorestarter module.
23

4+
---
35
### `AutoRestartScheduled`
46

57
**Purpose**
@@ -97,3 +99,4 @@ hook.Add("AutoRestartCountdown", "DisplayTimer", function(remaining)
9799
print(remaining .. " seconds until restart")
98100
end)
99101
```
102+
---

bodygrouper/docs/hooks.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# Hooks
2+
Module-specific events raised by the Bodygrouper module.
23

4+
---
35
### `BodygrouperClosetAddUser`
46

57
**Purpose**
@@ -369,3 +371,4 @@ hook.Add("BodygrouperValidated", "Notify", function(c, t)
369371
end)
370372
```
371373

374+
---

broadcasts/docs/hooks.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# Hooks
2+
Module-specific events raised by the Broadcasts module.
23

4+
---
35
### `PreClassBroadcastSend`
46

57
**Purpose**
@@ -264,3 +266,4 @@ hook.Add("FactionBroadcastLogged", "NotifyLog", function(client, msg)
264266
end)
265267
```
266268

269+
---

captions/docs/hooks.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# Hooks
2+
Module-specific events raised by the Captions module.
23

4+
---
35
### `SendCaptionCommand`
46

57
**Purpose**
@@ -104,3 +106,4 @@ hook.Add("CaptionFinished", "HandleCaptionEnd", function(client)
104106
-- cleanup logic here
105107
end)
106108
```
109+
---

captions/docs/libraries.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,3 @@
1-
# Libraries
2-
31
# Caption Library
42

53
This page documents the functions for working with on-screen captions.

cards/docs/hooks.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# Hooks
2+
Module-specific events raised by the Cards module.
23

4+
---
35
### `CardsCommandUsed`
46

57
**Purpose**
@@ -48,3 +50,4 @@ hook.Add("CardDrawn", "AnnounceCard", function(client, card)
4850
lia.chat.send(client, "me", "drew " .. card)
4951
end)
5052
```
53+
---

chatmessages/docs/hooks.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# Hooks
2+
Module-specific events raised by the Chatmessages module.
23

4+
---
35
### `ChatMessagesTimerStarted`
46

57
**Purpose**
@@ -48,3 +50,4 @@ hook.Add("ChatMessageSent", "ReactToMessage", function(index, text)
4850
chat.AddText(Color(0,255,0), "[Log]", color_white, " Message " .. index .. ": " .. text)
4951
end)
5052
```
53+
---

0 commit comments

Comments
 (0)