[Doc] Process comments from review

Co-authored-by: Benjamin Nauck <benjamin@nauck.se>
This commit is contained in:
Pieter Hijma
2025-04-21 15:21:44 +02:00
committed by Benjamin Nauck
parent 519b78d775
commit 05364b9eb4
5 changed files with 45 additions and 46 deletions

View File

@@ -595,7 +595,7 @@ protected:
};
/**
* Namespace for parsing expressions.
* @brief Namespace for parsing expressions.
*
* Contains functionality for parsing expressions, the units of
* expressions, whether a token is an identifier, unit, or constant.

View File

@@ -40,7 +40,7 @@ namespace App
{
/**
* A namespace for metadata for Python external addons.
* @brief A namespace for metadata for Python external addons.
*
* This namespace contains functionality to define the contents of a
* package.xml file, such as Contact, License, Url, and Dependency.

View File

@@ -29,7 +29,7 @@
#include <string>
/**
* A namespace for utilities.
* @brief A namespace for utilities.
*
* Currently, this namespace contains functionality to define custom syntax to
* parse command line options.

View File

@@ -69,43 +69,43 @@ public:
*/
enum Status
{
/// @brief Whether a property is touched.
/// Whether a property is touched.
Touched = 0,
/// @brief Whether a property can be modified.
/// Whether a property can be modified.
Immutable = 1,
/// @brief Whether a property is read-only for the property editor.
/// Whether a property is read-only for the property editor.
ReadOnly = 2,
/// @brief Whether the property is hidden in the property editor.
/// Whether the property is hidden in the property editor.
Hidden = 3,
/// @brief Whether a property is saved in the document.
/// Whether a property is saved in the document.
Transient = 4,
/// @brief To turn ON PropertyMaterial edit.
/// To turn ON PropertyMaterial edit.
MaterialEdit = 5,
/// @brief To turn OFF PropertyMaterialList edit.
/// To turn OFF PropertyMaterialList edit.
NoMaterialListEdit = 6,
/// @brief Whether a property is an output property.
/// Whether a property is an output property.
Output = 7,
/// @brief Whether a dynamic property can be removed.
/// Whether a dynamic property can be removed.
LockDynamic = 8,
/// @brief Prevents causing `Gui::Document::setModified()`
/// Prevents causing `Gui::Document::setModified()`.
NoModify = 9,
/// @brief Whether to allow change in a partial document.
/// Whether to allow change in a partial document.
PartialTrigger = 10,
/// @brief Whether to prevent to touch the owner for a recompute on property change.
/// Whether to prevent to touch the owner for a recompute on property change.
NoRecompute = 11,
/// @brief Whether a floating point number should be saved as single precision.
/// Whether a floating point number should be saved as single precision.
Single = 12,
/// @brief For PropertyLists, whether the order of the elements is
/// For PropertyLists, whether the order of the elements is
/// relevant for the container using it.
Ordered = 13,
/// @brief In case of expression binding, whether the expression on
/// In case of expression binding, whether the expression on
/// restore and touch the object on value change.
EvalOnRestore = 14,
/// @brief For internal use to avoid recursive signaling.
/// For internal use to avoid recursive signaling.
Busy = 15,
/// @brief Whether the linked object should be copied on change of the property.
/// Whether the linked object should be copied on change of the property.
CopyOnChange = 16,
/// @brief Whether the property editor should create a button for user defined editing.
/// Whether the property editor should create a button for user defined editing.
UserEdit = 17,
// The following bits are corresponding to PropertyType set when the
@@ -113,32 +113,32 @@ public:
// changed in runtime. It is mirrored here to save the linear search
// required in PropertyContainer::getPropertyType()
/// @brief Mark the beginning of enum PropertyType bits.
/// Mark the beginning of enum PropertyType bits.
PropStaticBegin = 21,
/// @brief Whether the property is dynamically added.
/// Whether the property is dynamically added.
PropDynamic = 21,
/// @brief Corresponds to Prop_NoPersist
/// Corresponds to Prop_NoPersist.
PropNoPersist = 22,
/// @brief Corresponds to Prop_NoRecompute
/// Corresponds to Prop_NoRecompute.
PropNoRecompute = 23,
/// @brief Corresponds to Prop_ReadOnly
/// Corresponds to Prop_ReadOnly.
PropReadOnly = 24,
/// @brief Corresponds to Prop_Transient
/// Corresponds to Prop_Transient.
PropTransient = 25,
/// @brief Corresponds to Prop_Hidden
/// Corresponds to Prop_Hidden.
PropHidden = 26,
/// @brief Corresponds to Prop_Output
/// Corresponds to Prop_Output.
PropOutput = 27,
/// @brief Mark the end of enum PropertyType bits.
/// Mark the end of enum PropertyType bits.
PropStaticEnd = 28,
/// @brief User defined status bit.
/// User defined status bit.
User1 = 28,
/// @brief User defined status bit.
/// User defined status bit.
User2 = 29,
/// @brief User defined status bit.
/// User defined status bit.
User3 = 30,
/// @brief User defined status bit.
/// User defined status bit.
User4 = 31
};

View File

@@ -54,19 +54,19 @@ class Extension;
*/
enum PropertyType
{
/// @brief No special property type.
/// No special property type.
Prop_None = 0,
/// @brief The property is read-only in the editor.
/// The property is read-only in the editor.
Prop_ReadOnly = 1,
/// @brief The property content won't be saved to file, but still saves name, type and status.
/// The property content won't be saved to file, but still saves name, type and status.
Prop_Transient = 2,
/// @brief The property is hidden in the editor.
/// The property is hidden in the editor.
Prop_Hidden = 4,
/// @brief A modified property doesn't touch its parent container.
/// A modified property doesn't touch its parent container.
Prop_Output = 8,
/// @brief A modified property doesn't touch its container for recompute.
/// A modified property doesn't touch its container for recompute.
Prop_NoRecompute = 16,
/// @brief property won't be saved to file at all.
/// The property won't be saved to file at all.
Prop_NoPersist = 32,
};
// clang-format on
@@ -583,16 +583,15 @@ protected:
public:
/// @brief The copy constructor is deleted to prevent copying.
/// The copy constructor is deleted to prevent copying.
PropertyContainer(const PropertyContainer&) = delete;
/// @brief The assignment operator is deleted to prevent assignment.
/// The assignment operator is deleted to prevent assignment.
PropertyContainer& operator = (const PropertyContainer&) = delete;
protected:
/**
* @brief The container for dynamic properties.
*/
/// The container for dynamic properties.
DynamicProperty dynamicProps;
private: