aboutsummaryrefslogtreecommitdiffstats
path: root/pyGHDL/dom
diff options
context:
space:
mode:
authorPatrick Lehmann <Patrick.Lehmann@plc2.de>2021-01-02 11:14:25 +0100
committertgingold <tgingold@users.noreply.github.com>2021-01-02 22:05:15 +0100
commit7c80587d3c0edfc5f11bc1004db80498bca5c05c (patch)
treeecaff7e6eacfce860b633dc7a46827bbea6fb30b /pyGHDL/dom
parentdf7dcf48f31c7bf393ce3c85f37d4db3c3761adb (diff)
downloadghdl-7c80587d3c0edfc5f11bc1004db80498bca5c05c.tar.gz
ghdl-7c80587d3c0edfc5f11bc1004db80498bca5c05c.tar.bz2
ghdl-7c80587d3c0edfc5f11bc1004db80498bca5c05c.zip
Added documentation.
(cherry picked from commit e55be23d658216c3a017bb5bec8452ad78548b43)
Diffstat (limited to 'pyGHDL/dom')
-rw-r--r--pyGHDL/dom/Common.py4
-rw-r--r--pyGHDL/dom/DesignUnit.py8
-rw-r--r--pyGHDL/dom/Misc.py4
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