From 6704cc6aff76eca7e6bdfdd96c46b31238334458 Mon Sep 17 00:00:00 2001 From: Chris Hennes Date: Sun, 17 Sep 2023 13:46:19 -0500 Subject: [PATCH] App/Toponaming: Clarify return value of addStringHasher --- src/App/Document.h | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/src/App/Document.h b/src/App/Document.h index 4e4d65e0424f..1f89b74ec538 100644 --- a/src/App/Document.h +++ b/src/App/Document.h @@ -473,22 +473,22 @@ class AppExport Document : public App::PropertyContainer (const App::DocumentObject* from, const App::DocumentObject* to) const; //@} - /** Called by property during properly save its containing StringHasher + /** Called by a property during save to store its StringHasher * * @param hasher: the input hasher * @return Returns a pair. The boolean indicates if the - * StringHasher has been saved before. The integer is the hasher index. + * StringHasher has been added before. The integer is the hasher index. * * The StringHasher object is designed to be shared among multiple objects. * We must not save duplicate copies of the same hasher, and must be * able to restore with the same sharing relationship. This function returns - * whether the hasher has been saved before by other objects, and the index - * of the hasher. If the hasher has not been saved before, the object must + * whether the hasher has been added before by other objects, and the index + * of the hasher. If the hasher has not been added before, the object must * save the hasher by calling StringHasher::Save */ std::pair addStringHasher(const StringHasherRef & hasher) const; - /** Called by property to restore its containing StringHasher + /** Called by property to restore its StringHasher * * @param index: the index previously returned by calling addStringHasher() * during save. Or if is negative, then return document's own string hasher.