Merge pull request #110 from LiliaFramework/codex/add-line-breaks-in-documentation-files

Apply consistent line breaks in docs

Author: bleonheart

advert/docs/hooks.md

@@ -1,21 +1,27 @@
 # Hooks
+
 Module-specific events raised by the Advert module.
 
 ---
+
 ### `AdvertSent`
 
 **Purpose**
+
 `Fires after a player successfully sends an advertisement message.`
 
 **Parameters**
 
 * `client` (`Player`): `Player who posted the advert.`
+
 * `message` (`string`): `Text that was advertised.`
 
 **Realm**
+
 `Server`
 
 **Returns**
+
 `nil` — `This hook does not return anything.`
 
 **Example**
@@ -27,3 +33,4 @@ end)
 ```
 
 ---
+

alcoholism/docs/hooks.md

@@ -1,21 +1,27 @@
 # Hooks
+
 Module-specific events raised by the Alcoholism module.
 
 ---
+
 ### `BACChanged`
 
 **Purpose**
+
 `Called whenever a player's Blood Alcohol Content (BAC) value is updated.`
 
 **Parameters**
 
 * `client` (`Player`): `The player whose BAC changed.`
+
 * `newBac` (`number`): `The player's new BAC value.`
 
 **Realm**
+
 `Server`
 
 **Returns**
+
 `nil` — `This hook does not return anything.`
 
 **Example**
@@ -31,16 +37,19 @@ end)
 ### `BACReset`
 
 **Purpose**
+
 `Runs when a player's BAC is reset to 0.`
 
 **Parameters**
 
 * `client` (`Player`): `The player whose BAC was reset.`
 
 **Realm**
+
 `Server`
 
 **Returns**
+
 `nil`
 
 **Example**
@@ -56,18 +65,23 @@ end)
 ### `BACIncreased`
 
 **Purpose**
+
 `Fires when a player's BAC is increased through consuming alcohol.`
 
 **Parameters**
 
 * `client` (`Player`): `The affected player.`
+
 * `amount` (`number`): `Amount added to the BAC.`
+
 * `newBac` (`number`): `The resulting BAC value.`
 
 **Realm**
+
 `Server`
 
 **Returns**
+
 `nil`
 
 **Example**
@@ -83,17 +97,21 @@ end)
 ### `AlcoholConsumed`
 
 **Purpose**
+
 `Triggered when an alcohol item is used by a player.`
 
 **Parameters**
 
 * `client` (`Player`): `Player that consumed the item.`
+
 * `item` (`Item`): `The alcohol item that was consumed.`
 
 **Realm**
+
 `Server`
 
 **Returns**
+
 `nil`
 
 **Example**
@@ -109,16 +127,19 @@ end)
 ### `PreBACReset`
 
 **Purpose**
+
 `Runs right before a player's BAC value is cleared.`
 
 **Parameters**
 
 * `client` (`Player`): `The player about to be reset.`
 
 **Realm**
+
 `Server`
 
 **Returns**
+
 `nil`
 
 **Example**
@@ -134,16 +155,19 @@ end)
 ### `PostBACReset`
 
 **Purpose**
+
 `Called after a player's BAC has been cleared.`
 
 **Parameters**
 
 * `client` (`Player`): `The player that was reset.`
 
 **Realm**
+
 `Server`
 
 **Returns**
+
 `nil`
 
 **Example**
@@ -159,17 +183,21 @@ end)
 ### `PreBACIncrease`
 
 **Purpose**
+
 `Invoked before a player's BAC value increases.`
 
 **Parameters**
 
 * `client` (`Player`): `The affected player.`
+
 * `amount` (`number`): `Amount being added.`
 
 **Realm**
+
 `Server`
 
 **Returns**
+
 `nil`
 
 **Example**
@@ -185,17 +213,21 @@ end)
 ### `BACThresholdReached`
 
 **Purpose**
+
 `Fires when a player's BAC crosses the drunk threshold.`
 
 **Parameters**
 
 * `client` (`Player`): `The player who crossed the threshold.`
+
 * `newBac` (`number`): `Their new BAC value.`
 
 **Realm**
+
 `Server`
 
 **Returns**
+
 `nil`
 
 **Example**
@@ -211,17 +243,21 @@ end)
 ### `PreBACDecrease`
 
 **Purpose**
+
 `Runs before the server lowers a player's BAC over time.`
 
 **Parameters**
 
 * `client` (`Player`): `Player whose BAC will drop.`
+
 * `current` (`number`): `Their current BAC before drop.`
 
 **Realm**
+
 `Server`
 
 **Returns**
+
 `nil`
 
 **Example**
@@ -237,17 +273,21 @@ end)
 ### `PostBACDecrease`
 
 **Purpose**
+
 `Runs after a player's BAC has decayed for the tick.`
 
 **Parameters**
 
 * `client` (`Player`): `Affected player.`
+
 * `newBac` (`number`): `Their BAC after decay.`
 
 **Realm**
+
 `Server`
 
 **Returns**
+
 `nil`
 
 **Example**
@@ -259,3 +299,4 @@ end)
 ```
 
 ---
+

alcoholism/docs/meta.md

@@ -3,6 +3,7 @@
 Helper functions for tracking a player's blood alcohol content.
 
 ---
+
 ### Player:ResetBAC (Server)
 
 **Purpose**
@@ -36,7 +37,9 @@ client:ResetBAC()
 Raises the player's BAC by the specified amount.
 
 | Name    | Type   | Description        |
+
 | ------- | ------ | ------------------ |
+
 | `amount` | number | BAC points to add. |
 
 **Realm**
@@ -100,3 +103,4 @@ local level = client:GetBAC()
 ```
 
 ---
+

autorestarter/docs/hooks.md

@@ -1,20 +1,25 @@
 # Hooks
+
 Module-specific events raised by the Autorestarter module.
 
 ---
+
 ### `AutoRestartScheduled`
 
 **Purpose**
+
 `Called when the next automatic restart time is calculated.`
 
 **Parameters**
 
 * `timestamp` (`number`): `Unix time of the upcoming restart.`
 
 **Realm**
+
 `Server`
 
 **Returns**
+
 `nil`
 
 **Example**
@@ -30,16 +35,19 @@ end)
 ### `AutoRestart`
 
 **Purpose**
+
 `Fires right before the map is reloaded for the automatic restart.`
 
 **Parameters**
 
 * `timestamp` (`number`): `Time when the restart triggered.`
 
 **Realm**
+
 `Server`
 
 **Returns**
+
 `nil`
 
 **Example**
@@ -55,16 +63,19 @@ end)
 ### `AutoRestartStarted`
 
 **Purpose**
+
 `Runs when the restart command is issued.`
 
 **Parameters**
 
 * `map` (`string`): `Map that will be loaded.`
 
 **Realm**
+
 `Server`
 
 **Returns**
+
 `nil`
 
 **Example**
@@ -80,16 +91,19 @@ end)
 ### `AutoRestartCountdown`
 
 **Purpose**
+
 `Called periodically during the final quarter of the restart interval.`
 
 **Parameters**
 
 * `remaining` (`number`): `Seconds remaining until restart.`
 
 **Realm**
+
 `Server`
 
 **Returns**
+
 `nil`
 
 **Example**
@@ -101,3 +115,4 @@ end)
 ```
 
 ---
+