diff options
Diffstat (limited to 'pyGHDL')
-rw-r--r-- | pyGHDL/dom/Common.py | 4 | ||||
-rw-r--r-- | pyGHDL/dom/DesignUnit.py | 8 | ||||
-rw-r--r-- | pyGHDL/dom/Misc.py | 4 |
3 files changed, 16 insertions, 0 deletions
diff --git a/pyGHDL/dom/Common.py b/pyGHDL/dom/Common.py index 8f1419651..adccbe38a 100644 --- a/pyGHDL/dom/Common.py +++ b/pyGHDL/dom/Common.py @@ -32,6 +32,10 @@ # SPDX-License-Identifier: GPL-2.0-or-later # ============================================================================ # +""" +.. todo:: + Add a module documentation. +""" from pydecor import export from pyVHDLModel.VHDLModel import Modes diff --git a/pyGHDL/dom/DesignUnit.py b/pyGHDL/dom/DesignUnit.py index 20b1dd92c..331b2526a 100644 --- a/pyGHDL/dom/DesignUnit.py +++ b/pyGHDL/dom/DesignUnit.py @@ -32,6 +32,14 @@ # SPDX-License-Identifier: GPL-2.0-or-later # ============================================================================ # +""" +This module contains all DOM classes for VHDL's design units (:cls:`entity <Entity>`, +:cls:`architecture <Architecture>`, :cls:`package <Package>`, +:cls:`package body <PackageBody>`, :cls:`context <Context>` and +:cls:`configuration <Configuration>`. + + +""" from pydecor import export from pyVHDLModel.VHDLModel import Entity as VHDLModel_Entity diff --git a/pyGHDL/dom/Misc.py b/pyGHDL/dom/Misc.py index fb8dd549a..4f931f15d 100644 --- a/pyGHDL/dom/Misc.py +++ b/pyGHDL/dom/Misc.py @@ -32,6 +32,10 @@ # SPDX-License-Identifier: GPL-2.0-or-later # ============================================================================ # +""" +.. todo:: + Add a module documentation. +""" from pathlib import Path from typing import Any |