From 7c80587d3c0edfc5f11bc1004db80498bca5c05c Mon Sep 17 00:00:00 2001
From: Patrick Lehmann <Patrick.Lehmann@plc2.de>
Date: Sat, 2 Jan 2021 11:14:25 +0100
Subject: Added documentation.

(cherry picked from commit e55be23d658216c3a017bb5bec8452ad78548b43)
---
 pyGHDL/dom/Common.py     | 4 ++++
 pyGHDL/dom/DesignUnit.py | 8 ++++++++
 pyGHDL/dom/Misc.py       | 4 ++++
 3 files changed, 16 insertions(+)

(limited to 'pyGHDL/dom')

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
 
-- 
cgit v1.2.3