[lmi-commits] [lmi] master 9b0f657 1/7: Improve documentation

[Greg Chicares]

branch: master
commit 9b0f657ef1a7963017ffebbd377a5fc93794b955
Author: Gregory W. Chicares <address@hidden>
Commit: Gregory W. Chicares <address@hidden>

    Improve documentation
    
    Added a comment to explain why commit 5249af038f of 20190128T1713Z
    added a DBInit() call not only to
      Database::Database()
    but also to
      Database::Database(std::string const&)
    as well.
---
 dbdict.cpp | 6 ++++++
 1 file changed, 6 insertions(+)

diff --git a/dbdict.cpp b/dbdict.cpp
index dbcac98..7b60cb6 100644
--- a/dbdict.cpp
+++ b/dbdict.cpp
@@ -91,6 +91,12 @@ DBDictionary::DBDictionary()
     InitDB();
 }
 
+/// Construct from a '.database' file.
+///
+/// Call InitDB() unconditionally before Init(), even though that may
+/// seem unnecessary, in case the file read by Init() lacks any member
+/// entity (because it's an older version or has been edited, e.g.).
+
 DBDictionary::DBDictionary(std::string const& filename)
 {
     ascribe_members();