Skip to content

Commit 84b57d6

Browse files
pieterhijmahyarion
andcommitted
[Doc] Process comments from review
Co-authored-by: Benjamin Nauck <benjamin@nauck.se>
1 parent 108dafb commit 84b57d6

File tree

5 files changed

+45
-46
lines changed

5 files changed

+45
-46
lines changed

src/App/ExpressionParser.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -595,7 +595,7 @@ class AppExport RangeExpression: public App::Expression
595595
};
596596

597597
/**
598-
* Namespace for parsing expressions.
598+
* @brief Namespace for parsing expressions.
599599
*
600600
* Contains functionality for parsing expressions, the units of
601601
* expressions, whether a token is an identifier, unit, or constant.

src/App/Metadata.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ namespace App
4040
{
4141

4242
/**
43-
* A namespace for metadata for Python external addons.
43+
* @brief A namespace for metadata for Python external addons.
4444
*
4545
* This namespace contains functionality to define the contents of a
4646
* package.xml file, such as Contact, License, Url, and Dependency.

src/App/ProgramOptionsUtilities.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@
2929
#include <string>
3030

3131
/**
32-
* A namespace for utilities.
32+
* @brief A namespace for utilities.
3333
*
3434
* Currently, this namespace contains functionality to define custom syntax to
3535
* parse command line options.

src/App/Property.h

Lines changed: 31 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -69,76 +69,76 @@ class AppExport Property: public Base::Persistence
6969
*/
7070
enum Status
7171
{
72-
/// @brief Whether a property is touched.
72+
/// Whether a property is touched.
7373
Touched = 0,
74-
/// @brief Whether a property can be modified.
74+
/// Whether a property can be modified.
7575
Immutable = 1,
76-
/// @brief Whether a property is read-only for the property editor.
76+
/// Whether a property is read-only for the property editor.
7777
ReadOnly = 2,
78-
/// @brief Whether the property is hidden in the property editor.
78+
/// Whether the property is hidden in the property editor.
7979
Hidden = 3,
80-
/// @brief Whether a property is saved in the document.
80+
/// Whether a property is saved in the document.
8181
Transient = 4,
82-
/// @brief To turn ON PropertyMaterial edit.
82+
/// To turn ON PropertyMaterial edit.
8383
MaterialEdit = 5,
84-
/// @brief To turn OFF PropertyMaterialList edit.
84+
/// To turn OFF PropertyMaterialList edit.
8585
NoMaterialListEdit = 6,
86-
/// @brief Whether a property is an output property.
86+
/// Whether a property is an output property.
8787
Output = 7,
88-
/// @brief Whether a dynamic property can be removed.
88+
/// Whether a dynamic property can be removed.
8989
LockDynamic = 8,
90-
/// @brief Prevents causing `Gui::Document::setModified()`
90+
/// Prevents causing `Gui::Document::setModified()`.
9191
NoModify = 9,
92-
/// @brief Whether to allow change in a partial document.
92+
/// Whether to allow change in a partial document.
9393
PartialTrigger = 10,
94-
/// @brief Whether to prevent to touch the owner for a recompute on property change.
94+
/// Whether to prevent to touch the owner for a recompute on property change.
9595
NoRecompute = 11,
96-
/// @brief Whether a floating point number should be saved as single precision.
96+
/// Whether a floating point number should be saved as single precision.
9797
Single = 12,
98-
/// @brief For PropertyLists, whether the order of the elements is
98+
/// For PropertyLists, whether the order of the elements is
9999
/// relevant for the container using it.
100100
Ordered = 13,
101-
/// @brief In case of expression binding, whether the expression on
101+
/// In case of expression binding, whether the expression on
102102
/// restore and touch the object on value change.
103103
EvalOnRestore = 14,
104-
/// @brief For internal use to avoid recursive signaling.
104+
/// For internal use to avoid recursive signaling.
105105
Busy = 15,
106-
/// @brief Whether the linked object should be copied on change of the property.
106+
/// Whether the linked object should be copied on change of the property.
107107
CopyOnChange = 16,
108-
/// @brief Whether the property editor should create a button for user defined editing.
108+
/// Whether the property editor should create a button for user defined editing.
109109
UserEdit = 17,
110110

111111
// The following bits are corresponding to PropertyType set when the
112112
// property added. These types are meant to be static, and cannot be
113113
// changed in runtime. It is mirrored here to save the linear search
114114
// required in PropertyContainer::getPropertyType()
115115

116-
/// @brief Mark the beginning of enum PropertyType bits.
116+
/// Mark the beginning of enum PropertyType bits.
117117
PropStaticBegin = 21,
118-
/// @brief Whether the property is dynamically added.
118+
/// Whether the property is dynamically added.
119119
PropDynamic = 21,
120-
/// @brief Corresponds to Prop_NoPersist
120+
/// Corresponds to Prop_NoPersist.
121121
PropNoPersist = 22,
122-
/// @brief Corresponds to Prop_NoRecompute
122+
/// Corresponds to Prop_NoRecompute.
123123
PropNoRecompute = 23,
124-
/// @brief Corresponds to Prop_ReadOnly
124+
/// Corresponds to Prop_ReadOnly.
125125
PropReadOnly = 24,
126-
/// @brief Corresponds to Prop_Transient
126+
/// Corresponds to Prop_Transient.
127127
PropTransient = 25,
128-
/// @brief Corresponds to Prop_Hidden
128+
/// Corresponds to Prop_Hidden.
129129
PropHidden = 26,
130-
/// @brief Corresponds to Prop_Output
130+
/// Corresponds to Prop_Output.
131131
PropOutput = 27,
132-
/// @brief Mark the end of enum PropertyType bits.
132+
/// Mark the end of enum PropertyType bits.
133133
PropStaticEnd = 28,
134134

135-
/// @brief User defined status bit.
135+
/// User defined status bit.
136136
User1 = 28,
137-
/// @brief User defined status bit.
137+
/// User defined status bit.
138138
User2 = 29,
139-
/// @brief User defined status bit.
139+
/// User defined status bit.
140140
User3 = 30,
141-
/// @brief User defined status bit.
141+
/// User defined status bit.
142142
User4 = 31
143143
};
144144

src/App/PropertyContainer.h

Lines changed: 11 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -54,19 +54,19 @@ class Extension;
5454
*/
5555
enum PropertyType
5656
{
57-
/// @brief No special property type.
57+
/// No special property type.
5858
Prop_None = 0,
59-
/// @brief The property is read-only in the editor.
59+
/// The property is read-only in the editor.
6060
Prop_ReadOnly = 1,
61-
/// @brief The property content won't be saved to file, but still saves name, type and status.
61+
/// The property content won't be saved to file, but still saves name, type and status.
6262
Prop_Transient = 2,
63-
/// @brief The property is hidden in the editor.
63+
/// The property is hidden in the editor.
6464
Prop_Hidden = 4,
65-
/// @brief A modified property doesn't touch its parent container.
65+
/// A modified property doesn't touch its parent container.
6666
Prop_Output = 8,
67-
/// @brief A modified property doesn't touch its container for recompute.
67+
/// A modified property doesn't touch its container for recompute.
6868
Prop_NoRecompute = 16,
69-
/// @brief property won't be saved to file at all.
69+
/// The property won't be saved to file at all.
7070
Prop_NoPersist = 32,
7171
};
7272
// clang-format on
@@ -583,16 +583,15 @@ class AppExport PropertyContainer: public Base::Persistence
583583

584584
public:
585585

586-
/// @brief The copy constructor is deleted to prevent copying.
586+
/// The copy constructor is deleted to prevent copying.
587587
PropertyContainer(const PropertyContainer&) = delete;
588588

589-
/// @brief The assignment operator is deleted to prevent assignment.
589+
/// The assignment operator is deleted to prevent assignment.
590590
PropertyContainer& operator = (const PropertyContainer&) = delete;
591591

592592
protected:
593-
/**
594-
* @brief The container for dynamic properties.
595-
*/
593+
594+
/// The container for dynamic properties.
596595
DynamicProperty dynamicProps;
597596

598597
private:

0 commit comments

Comments
 (0)