From c0ad631039662c587ba57e030ec99b6a8108386c Mon Sep 17 00:00:00 2001
From: "Veronica K. B. Olsen" <1619840+vkbo@users.noreply.github.com>
Date: Fri, 23 Oct 2020 21:05:41 +0200
Subject: [PATCH] Updated source file descriptions

---
 nw/config.py             | 2 +-
 nw/core/document.py      | 2 +-
 nw/core/index.py         | 2 +-
 nw/core/spellcheck.py    | 2 +-
 nw/core/status.py        | 2 +-
 nw/core/tokenizer.py     | 2 +-
 nw/core/tree.py          | 2 +-
 nw/gui/build.py          | 8 ++++----
 nw/gui/doceditor.py      | 2 +-
 nw/gui/dochighlight.py   | 2 +-
 nw/gui/docmerge.py       | 2 +-
 nw/gui/docviewer.py      | 2 +-
 nw/gui/itemdetails.py    | 2 +-
 nw/gui/itemeditor.py     | 2 +-
 nw/gui/mainmenu.py       | 4 ++--
 nw/gui/outlinedetails.py | 2 +-
 nw/gui/projload.py       | 2 +-
 nw/gui/projtree.py       | 2 +-
 nw/gui/theme.py          | 2 +-
 nw/gui/writingstats.py   | 2 +-
 nw/guimain.py            | 2 +-
 21 files changed, 25 insertions(+), 25 deletions(-)

diff --git a/nw/config.py b/nw/config.py
index bc777812..0aa6cf50 100644
--- a/nw/config.py
+++ b/nw/config.py
@@ -3,7 +3,7 @@
 
  novelWriter – Config Class
 ============================
- This class reads and store the main preferences of the application
+ Class reading and holding the preferences of the application
 
  File History:
  Created: 2018-09-22 [0.0.1]
diff --git a/nw/core/document.py b/nw/core/document.py
index 1452e9dd..b1056a6b 100644
--- a/nw/core/document.py
+++ b/nw/core/document.py
@@ -3,7 +3,7 @@
 
  novelWriter – Project Document
 ================================
- Class holding a document
+ Class holding a single novelWriter document
 
  File History:
  Created: 2018-09-29 [0.0.1]
diff --git a/nw/core/index.py b/nw/core/index.py
index 97ad7ba4..29f80ea9 100644
--- a/nw/core/index.py
+++ b/nw/core/index.py
@@ -3,7 +3,7 @@
 
  novelWriter – Project Index
 =============================
- Class holding the index of tags
+ Class holding the project index of tags, headers and references
 
  File History:
  Created: 2019-05-27 [0.1.4]
diff --git a/nw/core/spellcheck.py b/nw/core/spellcheck.py
index e3093070..7223c616 100644
--- a/nw/core/spellcheck.py
+++ b/nw/core/spellcheck.py
@@ -3,7 +3,7 @@
 
  novelWriter – Spell Check Classes
 ===================================
- Wrapper class for spell checking
+ Wrapper class for spell checking tools
 
  File History:
  Created: 2019-06-11 [0.1.5]
diff --git a/nw/core/status.py b/nw/core/status.py
index a2e5b92a..7a1c7127 100644
--- a/nw/core/status.py
+++ b/nw/core/status.py
@@ -3,7 +3,7 @@
 
  novelWriter – Project Item Status Class
 =========================================
- Class holding the status elements of a project item
+ Class holding the status/importance elements of a project item
 
  File History:
  Created: 2019-05-19 [0.1.3]
diff --git a/nw/core/tokenizer.py b/nw/core/tokenizer.py
index 5087c67c..c7b23208 100644
--- a/nw/core/tokenizer.py
+++ b/nw/core/tokenizer.py
@@ -3,7 +3,7 @@
 
  novelWriter – Text Tokenizer
 ==============================
- Splits a piece of nW markdown text into its elements
+ Splits a piece of novelWriter markdown text into its elements
 
  File History:
  Created: 2019-05-05 [0.0.1]
diff --git a/nw/core/tree.py b/nw/core/tree.py
index f33b0d59..fc908745 100644
--- a/nw/core/tree.py
+++ b/nw/core/tree.py
@@ -3,7 +3,7 @@
 
  novelWriter – Project Tree Class
 ==================================
- Class holding the data of the project tree
+ Class holding the project's tree of project items
 
  File History:
  Created: 2020-05-07 [0.4.5]
diff --git a/nw/gui/build.py b/nw/gui/build.py
index 9b8b42ac..4a8f8aad 100644
--- a/nw/gui/build.py
+++ b/nw/gui/build.py
@@ -1,9 +1,9 @@
 # -*- coding: utf-8 -*-
-"""novelWriter GUI Build Novel
+"""novelWriter GUI Build Novel Project
 
- novelWriter – GUI Build Novel
-===============================
- Class holding the build novel window
+ novelWriter – GUI Build Novel Project
+=======================================
+ Class holding the build novel project dialog
 
  File History:
  Created: 2020-05-09 [0.5]
diff --git a/nw/gui/doceditor.py b/nw/gui/doceditor.py
index 9a2cb683..a24a1f4e 100644
--- a/nw/gui/doceditor.py
+++ b/nw/gui/doceditor.py
@@ -3,7 +3,7 @@
 
  novelWriter – GUI Document Editor
 ===================================
- Class holding the document editor
+ Class holding the main document editor
 
  File History:
  Created:   2018-09-29 [0.0.1]  GuiDocEditor
diff --git a/nw/gui/dochighlight.py b/nw/gui/dochighlight.py
index cc11ef86..309b74a8 100644
--- a/nw/gui/dochighlight.py
+++ b/nw/gui/dochighlight.py
@@ -3,7 +3,7 @@
 
  novelWriter – GUI Document Highlighter
 ========================================
- Syntax highlighting for MarkDown
+ Subclass for the main editor syntax highlighting
 
  File History:
  Created: 2019-04-06 [0.0.1]
diff --git a/nw/gui/docmerge.py b/nw/gui/docmerge.py
index d7d128fe..f2a49e19 100644
--- a/nw/gui/docmerge.py
+++ b/nw/gui/docmerge.py
@@ -3,7 +3,7 @@
 
  novelWriter – GUI Doc Merge
 =============================
- Tool for merging multiple documents to one
+ Tool for merging multiple documents to one document
 
  File History:
  Created: 2020-01-23 [0.4.3]
diff --git a/nw/gui/docviewer.py b/nw/gui/docviewer.py
index 0c9a8086..636c4637 100644
--- a/nw/gui/docviewer.py
+++ b/nw/gui/docviewer.py
@@ -3,7 +3,7 @@
 
  novelWriter – GUI Document Viewer
 ===================================
- Class holding the document html viewer
+ Class holding the main document viewer
 
  File History:
  Created: 2019-05-10 [0.0.1] GuiDocViewer
diff --git a/nw/gui/itemdetails.py b/nw/gui/itemdetails.py
index 6d5cbcb5..da1a8f4a 100644
--- a/nw/gui/itemdetails.py
+++ b/nw/gui/itemdetails.py
@@ -3,7 +3,7 @@
 
  novelWriter – GUI Document Details
 ====================================
- Class holding the left side document details panel
+ Class holding the project tree item details panel
 
  File History:
  Created: 2019-04-24 [0.0.1]
diff --git a/nw/gui/itemeditor.py b/nw/gui/itemeditor.py
index 95a68c82..a56a93bf 100644
--- a/nw/gui/itemeditor.py
+++ b/nw/gui/itemeditor.py
@@ -3,7 +3,7 @@
 
  novelWriter – GUI Item Editor
 ===============================
- Class holding the item editor
+ Class holding the item editor dialog
 
  File History:
  Created: 2019-04-27 [0.0.1]
diff --git a/nw/gui/mainmenu.py b/nw/gui/mainmenu.py
index 7fcd2a89..706b5bba 100644
--- a/nw/gui/mainmenu.py
+++ b/nw/gui/mainmenu.py
@@ -3,10 +3,10 @@
 
  novelWriter – GUI Main Menu
 =============================
- Class holding the main window
+ Class holding the main window menu
 
  File History:
- Created: 2019-04-27 [0.0.1] (Split from winmain)
+ Created: 2019-04-27 [0.0.1]
 
  This file is a part of novelWriter
  Copyright 2018–2020, Veronica Berglyd Olsen
diff --git a/nw/gui/outlinedetails.py b/nw/gui/outlinedetails.py
index 18f2b90f..d19bf2e9 100644
--- a/nw/gui/outlinedetails.py
+++ b/nw/gui/outlinedetails.py
@@ -3,7 +3,7 @@
 
  novelWriter – GUI Project Outline Details
 ===========================================
- Class holding the project outline details view
+ Class holding the project outline details panel
 
  File History:
  Created: 2020-06-02 [0.7.0]
diff --git a/nw/gui/projload.py b/nw/gui/projload.py
index 29c9c9ab..35621032 100644
--- a/nw/gui/projload.py
+++ b/nw/gui/projload.py
@@ -3,7 +3,7 @@
 
  novelWriter – GUI Open Project
 ================================
- The open project dialog
+ Class holding the load/browse/new project dialog
 
  File History:
  Created: 2020-02-26 [0.4.5]
diff --git a/nw/gui/projtree.py b/nw/gui/projtree.py
index 77fdf610..89e41374 100644
--- a/nw/gui/projtree.py
+++ b/nw/gui/projtree.py
@@ -3,7 +3,7 @@
 
  novelWriter – GUI project Tree
 ================================
- Class holding the left side project tree view
+ Class holding the project tree view
 
  File History:
  Created: 2018-09-29 [0.0.1] GuiProjectTree
diff --git a/nw/gui/theme.py b/nw/gui/theme.py
index 9d907a67..2b5f31f5 100644
--- a/nw/gui/theme.py
+++ b/nw/gui/theme.py
@@ -3,7 +3,7 @@
 
  novelWriter – Theme and Icons Classs
 ======================================
- This class reads and stores the themes and the icons
+ Class managing and caching themes and icons
 
  File History:
  Created: 2019-05-18 [0.1.3] GuiTheme
diff --git a/nw/gui/writingstats.py b/nw/gui/writingstats.py
index c394c43d..fb10f7a4 100644
--- a/nw/gui/writingstats.py
+++ b/nw/gui/writingstats.py
@@ -3,7 +3,7 @@
 
  novelWriter – GUI Writing Statistics
 ======================================
- Class showing the word count and session statistics
+ Class holding the word count and session statistics dialog
 
  File History:
  Created: 2019-10-20 [0.3]
diff --git a/nw/guimain.py b/nw/guimain.py
index 6742a0d9..9b1a8a42 100644
--- a/nw/guimain.py
+++ b/nw/guimain.py
@@ -3,7 +3,7 @@
 
  novelWriter – GUI Main Window
 ===============================
- Class holding the main window
+ Class holding the main application window
 
  File History:
  Created: 2018-09-22 [0.0.1]