Tue May 8 12:43:12 UTC 2012 Marijke Hengstmengel <mhengstmengel@remedy.nl>

        * connectors/dds4ccm/tutorials/Shapes/Shapes_asm/Shapes_Control_comp/src/Shapes_Control_comp_exec.h:
        * connectors/dds4ccm/tutorials/Shapes/Shapes_asm/Shapes_Sender_comp/src/Shapes_Sender_comp_exec.h:
        * connectors/dds4ccm/tutorials/Shapes/Shapes_asm/Shapes_Receiver_comp/src/Shapes_Receiver_comp_exec.h:
        * connectors/dds4ccm/tutorials/Shapes/Tutorial/Code/Shapes_Control_comp/Shapes_Control_comp_exec.h:
        * connectors/dds4ccm/tutorials/Shapes/Tutorial/Code/Shapes_Sender_comp/Shapes_Sender_comp_exec.h:
        * connectors/dds4ccm/tutorials/Shapes/Tutorial/Code/Shapes_Receiver_comp/Shapes_Receiver_comp_exec.h:
        Generated executors again after adding new documentation in TAO_IDL .

1 files changed, 116 insertions, 31 deletions

diff --git a/CIAO/connectors/dds4ccm/tutorials/Shapes/Shapes_asm/Shapes_Control_comp/src/Shapes_Control_comp_exec.h b/CIAO/connectors/dds4ccm/tutorials/Shapes/Shapes_asm/Shapes_Control_comp/src/Shapes_Control_comp_exec.h
index 4f8a4b6c367..616f1616ddc 100644
--- a/CIAO/connectors/dds4ccm/tutorials/Shapes/Shapes_asm/Shapes_Control_comp/src/Shapes_Control_comp_exec.h
+++ b/CIAO/connectors/dds4ccm/tutorials/Shapes/Shapes_asm/Shapes_Control_comp/src/Shapes_Control_comp_exec.h
@@ -1,8 +1,31 @@
 // -*- C++ -*-
 // $Id$
 
-#ifndef CIAO__________TUTORIAL_CODE_SHAPES_CONTROL_COMP_SHAPES_CONTROL_COMP_EXEC_J4CMMK_H_
-#define CIAO__________TUTORIAL_CODE_SHAPES_CONTROL_COMP_SHAPES_CONTROL_COMP_EXEC_J4CMMK_H_
+/**
+ * Code generated by the The ACE ORB (TAO) IDL Compiler v2.1.1
+ * TAO and the TAO IDL Compiler have been developed by:
+ *       Center for Distributed Object Computing
+ *       Washington University
+ *       St. Louis, MO
+ *       USA
+ *       http://www.cs.wustl.edu/~schmidt/doc-center.html
+ * and
+ *       Distributed Object Computing Laboratory
+ *       University of California at Irvine
+ *       Irvine, CA
+ *       USA
+ * and
+ *       Institute for Software Integrated Systems
+ *       Vanderbilt University
+ *       Nashville, TN
+ *       USA
+ *       http://www.isis.vanderbilt.edu/
+ *
+ * Information about TAO is available at:
+ *     http://www.cs.wustl.edu/~schmidt/TAO.html
+ **/
+#ifndef CIAO_SHAPES_CONTROL_COMP_EXEC_WWONQX_H_
+#define CIAO_SHAPES_CONTROL_COMP_EXEC_WWONQX_H_
 
 #include /**/ "ace/pre.h"
 
@@ -16,6 +39,7 @@
 
 #include "tao/LocalObject.h"
 
+/// Namespace for implementation of Shapes::Control_comp component
 namespace CIAO_Shapes_Control_comp_Impl
 {
   class Control_comp_exec_i;
@@ -36,78 +60,130 @@ namespace CIAO_Shapes_Control_comp_Impl
     Control_comp_exec_i &pulse_callback_;
   };
 
-  //============================================================
-  // Component Executor Implementation Class: Control_comp_exec_i
-  //============================================================
-
+  /// Component Executor Implementation Class: Control_comp_exec_i
   class SHAPES_CONTROL_COMP_EXEC_Export Control_comp_exec_i
     : public virtual Control_comp_Exec,
       public virtual ::CORBA::LocalObject
   {
   public:
+    /// Constructor
     Control_comp_exec_i (void);
+    /// Destructor
     virtual ~Control_comp_exec_i (void);
 
+    /** @name Supported operations and attributes. */
     //@{
-    /** Supported operations and attributes. */
 
     //@}
 
+    /** @name Component attributes and port operations. */
     //@{
-    /** Component attributes and port operations. */
-
-    virtual ::CORBA::ULong rate (void);
-
-    virtual void rate (::CORBA::ULong rate);
-
-    virtual ::CORBA::UShort max_x (void);
-
-    virtual void max_x (::CORBA::UShort max_x);
 
-    virtual ::CORBA::UShort max_y (void);
-
-    virtual void max_y (::CORBA::UShort max_y);
-
-    virtual ::CORBA::UShort max_size (void);
-
-    virtual void max_size (::CORBA::UShort max_size);
-
-    virtual ::CORBA::Boolean resize_shape (void);
-
-    virtual void resize_shape (::CORBA::Boolean resize_shape);
+    /// Getter for rate attribute
+    /// @return value of rate attribute
+    virtual ::CORBA::ULong rate (
+      void);
+
+    /// Setter for rate attribute
+    /// @param[in] rate - New value for rate attribute
+    virtual void rate (
+      ::CORBA::ULong rate);
+
+    /// Getter for max_x attribute
+    /// @return value of max_x attribute
+    virtual ::CORBA::UShort max_x (
+      void);
+
+    /// Setter for max_x attribute
+    /// @param[in] max_x - New value for max_x attribute
+    virtual void max_x (
+      ::CORBA::UShort max_x);
+
+    /// Getter for max_y attribute
+    /// @return value of max_y attribute
+    virtual ::CORBA::UShort max_y (
+      void);
+
+    /// Setter for max_y attribute
+    /// @param[in] max_y - New value for max_y attribute
+    virtual void max_y (
+      ::CORBA::UShort max_y);
+
+    /// Getter for max_size attribute
+    /// @return value of max_size attribute
+    virtual ::CORBA::UShort max_size (
+      void);
+
+    /// Setter for max_size attribute
+    /// @param[in] max_size - New value for max_size attribute
+    virtual void max_size (
+      ::CORBA::UShort max_size);
+
+    /// Getter for resize_shape attribute
+    /// @return value of resize_shape attribute
+    virtual ::CORBA::Boolean resize_shape (
+      void);
+
+    /// Setter for resize_shape attribute
+    /// @param[in] resize_shape - New value for resize_shape attribute
+    virtual void resize_shape (
+      ::CORBA::Boolean resize_shape);
     //@}
 
+    /** @name Session component operations */
     //@{
-    /** Operations from Components::SessionComponent. */
 
+    /// Setter for container context for this component
+    /// @param[in] ctx - Container context
     virtual void set_session_context (::Components::SessionContext_ptr ctx);
 
+    /// Component state change method to configuration_complete state
     virtual void configuration_complete (void);
 
+    /// Component state change method to activated state
     virtual void ccm_activate (void);
+
+    /// Component state change method to passivated state
     virtual void ccm_passivate (void);
+
+    /// Component state change method to removed state
     virtual void ccm_remove (void);
     //@}
 
+    /** @name User defined public operations. */
     //@{
-    /** User defined operations */
     void tick (void);
-
     //@}
 
   private:
+    /// Context for component instance. Used for all middleware communication
     ::Shapes::CCM_Control_comp_Context_var ciao_context_;
 
+    /** @name Component attributes. */
+    //@{
+
+    /// Class member storing value of rate attribute
     ::CORBA::ULong rate_;
 
+    /// Class member storing value of max_x attribute
     ::CORBA::UShort max_x_;
 
+    /// Class member storing value of max_y attribute
     ::CORBA::UShort max_y_;
 
+    /// Class member storing value of max_size attribute
     ::CORBA::UShort max_size_;
 
+    /// Class member storing value of resize_shape attribute
     ::CORBA::Boolean resize_shape_;
+    //@}
 
+    /** @name Component facets. */
+    //@{
+    //@}
+
+    /** @name User defined members. */
+    //@{
     bool x_increasing_;
     bool y_increasing_;
     bool size_increasing_;
@@ -118,13 +194,22 @@ namespace CIAO_Shapes_Control_comp_Impl
 
     pulse_Generator * ticker_;
 
+    //@}
+
+    /** @name User defined private operations. */
+    //@{
     void start (void);
     void stop (void);
+    //@}
 
+    /// Get the ACE_Reactor
+    /// @return non-owning pointer to reactor
     ACE_Reactor* reactor (void);
   };
 
-  extern "C" SHAPES_CONTROL_COMP_EXEC_Export ::Components::EnterpriseComponent_ptr
+  /// Factory method and library entry point used by the middelware
+  /// @return new component instance
+  extern "C"  SHAPES_CONTROL_COMP_EXEC_Export ::Components::EnterpriseComponent_ptr
   create_Shapes_Control_comp_Impl (void);
 }