From 68cea8c32fc87750dc1c567af4f3cc7769cb503c Mon Sep 17 00:00:00 2001 From: Sean Cross Date: Tue, 24 Sep 2019 14:34:41 +0800 Subject: [PATCH] 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 --- litex/soc/cores/timer.py | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/litex/soc/cores/timer.py b/litex/soc/cores/timer.py index 08fc6ee09..def26cecd 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.