From: Sean Cross <sean@xobs.io>
Date: Tue, 24 Sep 2019 06:34:41 +0000 (+0800)
Subject: timer: inherit ModuleDoc
X-Git-Tag: 24jan2021_ls180~990^2
X-Git-Url: https://git.libre-soc.org/?a=commitdiff_plain;h=68cea8c32fc87750dc1c567af4f3cc7769cb503c;p=litex.git

timer: inherit ModuleDoc

With the new ModuleDoc class, we can inherit `ModuleDoc` and
automatically get module-level documentation.

This patch also corrects a typo in `timer` that causes an error in
sphinx.

Signed-off-by: Sean Cross <sean@xobs.io>
---

diff --git a/litex/soc/cores/timer.py b/litex/soc/cores/timer.py
index 08fc6ee0..def26cec 100644
--- a/litex/soc/cores/timer.py
+++ b/litex/soc/cores/timer.py
@@ -8,9 +8,9 @@ from migen import *
 
 from litex.soc.interconnect.csr import *
 from litex.soc.interconnect.csr_eventmanager import *
+from litex.soc.integration.doc import ModuleDoc
 
-
-class Timer(Module, AutoCSR):
+class Timer(Module, AutoCSR, ModuleDoc):
     """Timer
 
     Provides a generic Timer core.
@@ -21,7 +21,7 @@ class Timer(Module, AutoCSR):
     - Periodic: (Re-)Loads itself when value reaches 0.
 
     `en` register allows the user to enable/disable the Timer. When the Timer is enabled, it is
-    automatically loaded with the value of `load' register.
+    automatically loaded with the value of `load` register.
 
     When the Timer reaches 0, it is automatically reloaded with value of `reload` register.