From 00e200b50436b77400460dfeaf58ff26dc248118 Mon Sep 17 00:00:00 2001 From: ispyisail Date: Tue, 13 Oct 2026 23:03:14 +1300 Subject: [PATCH] Remove references to notes that are not in this repository Comments added with the lazy folios cited planning notes kept outside the QElectroTech repository, which a reader of the source cannot open. The sentences now stand on their own. Co-Authored-By: Claude Opus 5.5 --- sources/bordertitleblock.cpp | 4 ++-- sources/bordertitleblock.h | 4 ++-- sources/dataBase/projectdatabase.cpp | 2 +- sources/dataBase/projectdatabase.h | 8 ++++---- sources/diagram.h | 2 +- sources/qetgraphicsitem/conductor.cpp | 2 +- sources/qetgraphicsitem/element.cpp | 4 ++-- sources/qetproject.cpp | 8 +++----- sources/qetproject.h | 2 +- tests/qttest/lazy_folios_probe.cpp | 2 +- tests/qttest/tst_resaveunchanged.cpp | 6 +++--- 11 files changed, 21 insertions(+), 23 deletions(-) diff --git a/sources/bordertitleblock.cpp b/sources/bordertitleblock.cpp index f0e6f65c1..8747aa674 100644 --- a/sources/bordertitleblock.cpp +++ b/sources/bordertitleblock.cpp @@ -321,8 +321,8 @@ TitleBlockProperties BorderTitleBlock::localTitleBlock() const /** @brief BorderTitleBlock::current @return the properties of the titleblock: for a folio placed in a - project the project's store holds them (DB-ACCESSORS-PLAN.md stage - 4.4), for any other this object's own copy. + project the project's store holds them, for any other this object's + own copy. */ TitleBlockProperties BorderTitleBlock::current() const { diff --git a/sources/bordertitleblock.h b/sources/bordertitleblock.h index adc422752..009089c75 100644 --- a/sources/bordertitleblock.h +++ b/sources/bordertitleblock.h @@ -110,8 +110,8 @@ class BorderTitleBlock : public QObject QRectF insideBorderRect() const; // methods to get title block basic data. A folio placed in a - // project reads them from the project's store - // (DB-ACCESSORS-PLAN.md stage 4.4), any other from its own copy. + // project reads them from the project's store, any other from its + // own copy. /// @return the value of the title block "Author" field QString author() const { const TitleBlockProperties *s = stored(); return(s ? s->author : btb_author_); } /// @return the value of the title block "Date" field diff --git a/sources/dataBase/projectdatabase.cpp b/sources/dataBase/projectdatabase.cpp index 095945401..68a98486e 100644 --- a/sources/dataBase/projectdatabase.cpp +++ b/sources/dataBase/projectdatabase.cpp @@ -2497,7 +2497,7 @@ void projectDataBase::populateElementTable() /** @brief projectDataBase::populateElementInfoTable Populate the element info table from the symbol information store - (DB-ACCESSORS-PLAN.md stage 4.3), in the order of the element table. + in the order of the element table. The label column is the label a symbol shows, which its folio's numbering decides: the symbol holding the uuid gives it. diff --git a/sources/dataBase/projectdatabase.h b/sources/dataBase/projectdatabase.h index faf92ba6f..be3322c7d 100644 --- a/sources/dataBase/projectdatabase.h +++ b/sources/dataBase/projectdatabase.h @@ -114,7 +114,7 @@ class projectDataBase : public QObject //The information of every symbol placed in the project, by //symbol uuid: the store each symbol's information is written - //through (DB-ACCESSORS-PLAN.md stage 4.1). A symbol not placed + //through. A symbol not placed //(a preview, the symbol editor) keeps its own. DiagramContext elementInformation(const QUuid &element) const; bool hasElementInformation(const QUuid &element) const; @@ -132,7 +132,7 @@ class projectDataBase : public QObject //The title block properties of every folio of the project, by //folio uuid: the store each folio's title block is written - //through (DB-ACCESSORS-PLAN.md stage 4.4). A folio not in a + //through. A folio not in a //project keeps its own. TitleBlockProperties folioTitleBlock(const QUuid &folio) const; const TitleBlockProperties *storedFolioTitleBlock(const QUuid &folio) const; @@ -144,7 +144,7 @@ class projectDataBase : public QObject //The properties of every wire placed in the project, by wire //uuid: the store each wire's properties are written through - //(DB-ACCESSORS-PLAN.md stage 4.5). A wire not placed keeps its own. + //A wire not placed keeps its own. ConductorProperties conductorProperties(const QUuid &conductor) const; bool hasConductorProperties(const QUuid &conductor) const; int placedConductorCount(const QUuid &conductor) const; @@ -153,7 +153,7 @@ class projectDataBase : public QObject QStringList conductorPropertiesMismatches() const; //Fill the three stores from a project's document before its - //folios are built (DB-ACCESSORS-PLAN.md stage 4.6), then, once + //folios are built, then, once //they are, say how many of those values building agreed with. void prefillFromDocument(const QDomDocument &document); void endPrefill(bool keep_unplaced = false); diff --git a/sources/diagram.h b/sources/diagram.h index 6b2e6c604..44748c181 100644 --- a/sources/diagram.h +++ b/sources/diagram.h @@ -211,7 +211,7 @@ class Diagram : public QGraphicsScene bool = true, DiagramContent * = nullptr); /// false while this folio's items wait in its XML to be - /// built (QET_LAZY_FOLIOS, LAZY-FOLIO-PLAN.md) + /// built (QET_LAZY_FOLIOS) bool isLoaded() const {return m_deferred.isNull();} QDomElement deferredXml() const {return m_deferred;} QString headerXml(); diff --git a/sources/qetgraphicsitem/conductor.cpp b/sources/qetgraphicsitem/conductor.cpp index 720db396c..339c4a243 100644 --- a/sources/qetgraphicsitem/conductor.cpp +++ b/sources/qetgraphicsitem/conductor.cpp @@ -1857,7 +1857,7 @@ ConductorProperties Conductor::properties() const /** @brief Conductor::placedStore @return the project database holding this wire's properties - (DB-ACCESSORS-PLAN.md stage 4.5), or nullptr if it is not placed in a + or nullptr if it is not placed in a project, or shares its uuid with another wire for the moment a copy takes to get its own */ diff --git a/sources/qetgraphicsitem/element.cpp b/sources/qetgraphicsitem/element.cpp index 779c6f7c9..6a59bbcbc 100644 --- a/sources/qetgraphicsitem/element.cpp +++ b/sources/qetgraphicsitem/element.cpp @@ -1859,7 +1859,7 @@ void Element::setUuid(const QUuid &uuid) /** @brief Element::storeInformation Write this symbol's information to its project's store, once it is - placed (DB-ACCESSORS-PLAN.md stage 4.1): every change of a placed + placed: every change of a placed symbol's information comes through here. */ void Element::storeInformation() @@ -1925,7 +1925,7 @@ ElementData Element::elementData() const /** @brief Element::elementInformations @return this symbol's information: for a placed symbol the project's - store holds it (DB-ACCESSORS-PLAN.md stage 4.2), for one not placed + store holds it, for one not placed (a preview, the symbol editor) its own copy. */ DiagramContext Element::elementInformations() const diff --git a/sources/qetproject.cpp b/sources/qetproject.cpp index 676f20efb..7cdc79970 100644 --- a/sources/qetproject.cpp +++ b/sources/qetproject.cpp @@ -544,7 +544,7 @@ QETProject::ProjectState QETProject::state() const QList QETProject::diagrams() const { //Every caller of diagrams() expects every folio built: those that - //do not are moved to folios() one by one (LAZY-FOLIO-PLAN.md) + //do not are moved to folios() one by one loadFolios(); return(m_diagrams_list); } @@ -2291,8 +2291,7 @@ QDomDocument QETProject::toXml(QHash *kept_folios) loadFolios(); } //QET_CHECK_ELEMENT_INFO_STORE=1: say whether the stores of symbol - //information, folio title blocks and wire properties - //(DB-ACCESSORS-PLAN.md) agree with every placed symbol, folio and + //information, folio title blocks and wire properties agree with every placed symbol, folio and //wire, at each save. A test and debugging aid; it changes nothing. if (qEnvironmentVariableIntValue("QET_CHECK_ELEMENT_INFO_STORE") == 1) { const QStringList mismatches = m_data_base.elementInformationMismatches(); @@ -3015,7 +3014,7 @@ void QETProject::readProjectXml(QDomDocument &xml_project) //The stores of symbol information, folio title blocks and wire //properties are filled from the document before the folios are - //built (DB-ACCESSORS-PLAN.md stage 4.6) + //built m_data_base.prefillFromDocument(xml_project); //QET_LAZY_FOLIOS leaves the folios to be built when needed only @@ -3070,7 +3069,6 @@ void QETProject::readProjectXml(QDomDocument &xml_project) //number can hold what a save rewrites (tst_freetextnonfinite, //tst_foliofreezeflags): only with QET_LAZY_SAVE_KEPT=1, until a //.qetz, whose manifest names its writer, does it - //(QETZ-DB-TRUTH-PLAN.md D4) m_kept_folios_trusted = qEnvironmentVariableIntValue("QET_LAZY_SAVE_KEPT") == 1 && unloadedFolioCount() > 0 && m_project_qet_version == QetVersion::currentVersion() diff --git a/sources/qetproject.h b/sources/qetproject.h index 9bdc240c7..97987d1a9 100644 --- a/sources/qetproject.h +++ b/sources/qetproject.h @@ -122,7 +122,7 @@ class QETProject : public QObject ProjectState state() const; QList diagrams() const; //The folios whether their items are built or not - //(QET_LAZY_FOLIOS, LAZY-FOLIO-PLAN.md); diagrams() builds them + //(QET_LAZY_FOLIOS); diagrams() builds them QList folios() const; bool deferringFolios() const {return m_deferring_folios;} int unloadedFolioCount() const; diff --git a/tests/qttest/lazy_folios_probe.cpp b/tests/qttest/lazy_folios_probe.cpp index 94f238a35..2ed2d085e 100644 --- a/tests/qttest/lazy_folios_probe.cpp +++ b/tests/qttest/lazy_folios_probe.cpp @@ -1,5 +1,5 @@ // SPDX-License-Identifier: GPL-2.0-or-later -// Lazy folios (QET_LAZY_FOLIOS, LAZY-FOLIO-PLAN.md stages 5.2 and 5.3), +// Lazy folios (QET_LAZY_FOLIOS), // linked against the application's objects: a folio shown in a project // opened without building its folios draws and links as in the project // opened as usual, building only it and the folios its links and tables diff --git a/tests/qttest/tst_resaveunchanged.cpp b/tests/qttest/tst_resaveunchanged.cpp index 1babd2c55..c36ac8127 100644 --- a/tests/qttest/tst_resaveunchanged.cpp +++ b/tests/qttest/tst_resaveunchanged.cpp @@ -340,8 +340,8 @@ private slots: return QString::fromUtf8(proc.readAllStandardOutput() + proc.readAllStandardError()); } - // The stores of symbol information and folio title blocks - // (DB-ACCESSORS-PLAN.md stages 4.1, 4.4) agree with every placed symbol + // The stores of symbol information and folio title blocks agree with + // every placed symbol // and folio once a project is open: every example. void elementInfoStoreAgrees_data() { @@ -361,7 +361,7 @@ private slots: } // The stores filled from the document before the folios are built - // (DB-ACCESSORS-PLAN.md stage 4.6) hold what building them gives, for a + // hold what building them gives, for a // project saved by this version (every symbol, folio and wire carries // a uuid): nothing differs, nothing is left unplaced. void storesFilledBeforeBuilding()