Skip to content

Commit 18953dd

Browse files
blowekamphjmjohnson
authored andcommitted
DOC: Update Object::AddObserver documentation
The Command objects are derived from Object therefore SmartPointers are used.
1 parent b895526 commit 18953dd

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

Modules/Core/Common/include/itkObject.h

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -145,14 +145,14 @@ class ITKCommon_EXPORT Object : public LightObject
145145
SetGlobalWarningDisplay(false);
146146
}
147147

148-
/** Allow people to add/remove/invoke observers (callbacks) to any ITK
149-
* object. This is an implementation of the subject/observer design
148+
/** \brief Add an observer/command to this object invoked for event
149+
*
150+
* This is an implementation of the subject/observer design
150151
* pattern. An observer is added by specifying an event to respond to
151152
* and an itk::Command to execute. It returns an unsigned long tag
152153
* which can be used later to remove the event or retrieve the
153-
* command. The memory for the Command becomes the responsibility of
154-
* this object, so don't pass the same instance of a command to two
155-
* different objects */
154+
* command.
155+
*/
156156
unsigned long
157157
AddObserver(const EventObject & event, Command *);
158158
unsigned long

0 commit comments

Comments
 (0)