From a5dac4e0ad0344580982040686f1ce869d699471 Mon Sep 17 00:00:00 2001
From: Fen Dweller <chemicalcrux@gmail.com>
Date: Thu, 15 Oct 2020 13:58:44 -0400
Subject: [PATCH] Add a bit of documentation

---
 src/game/combat.ts       | 4 ++++
 src/game/combat/perks.ts | 3 +++
 2 files changed, 7 insertions(+)

diff --git a/src/game/combat.ts b/src/game/combat.ts
index 348a12b..682c2ba 100644
--- a/src/game/combat.ts
+++ b/src/game/combat.ts
@@ -244,6 +244,9 @@ export class UniformRandomDamageFormula implements DamageFormula {
   }
 }
 
+/**
+ * A [[DamageFormula]] that uses the attacker's stats
+ */
 export class StatDamageFormula implements DamageFormula {
   constructor (private factors: Array<{ stat: Stat|VoreStat; fraction: number; type: DamageType; target: Vigor|Stat }>) {
 
@@ -592,6 +595,7 @@ export class Effective {
     return []
   }
 }
+
 /**
  * A displayable status effect
  */
diff --git a/src/game/combat/perks.ts b/src/game/combat/perks.ts
index 0637eb1..ee7780c 100644
--- a/src/game/combat/perks.ts
+++ b/src/game/combat/perks.ts
@@ -7,6 +7,9 @@ import { DamageConsequence, LogConsequence } from './consequences'
 import { LogLine } from '../interface'
 import * as Words from '../words'
 
+/**
+ * A Perk is like a permanent status effect for a creature.
+ */
 export abstract class Perk extends Effective {
   constructor (public name: TextLike, public desc: TextLike) {
     super()