License conversion from Flora to Apache 2.0

[platform/core/uifw/dali-adaptor.git] / capi / dali / public-api / adaptor-framework / common / orientation.h

diff --git a/capi/dali/public-api/adaptor-framework/common/orientation.h b/capi/dali/public-api/adaptor-framework/common/orientation.h
index 46a4366..7f5696c 100644 (file)
--- a/capi/dali/public-api/adaptor-framework/common/orientation.h
+++ b/capi/dali/public-api/adaptor-framework/common/orientation.h
@@ -1,24 +1,25 @@
 #ifndef __DALI_ORIENTATION_H__
 #define __DALI_ORIENTATION_H__
 
-//
-// Copyright (c) 2014 Samsung Electronics Co., Ltd.
-//
-// Licensed under the Flora License, Version 1.0 (the License);
-// you may not use this file except in compliance with the License.
-// You may obtain a copy of the License at
-//
-//     http://floralicense.org/license/
-//
-// Unless required by applicable law or agreed to in writing, software
-// distributed under the License is distributed on an AS IS BASIS,
-// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-// See the License for the specific language governing permissions and
-// limitations under the License.
-//
+/*
+ * Copyright (c) 2014 Samsung Electronics Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
 
 /**
- * @addtogroup CAPI_DALI_FRAMEWORK
+ * @addtogroup CAPI_DALI_ADAPTOR_MODULE
  * @{
  */
 
@@ -40,7 +41,8 @@ class Orientation;
 }
 
 /**
- * Orientation allows the user to determine the orientation of the device.
+ * @brief Orientation allows the user to determine the orientation of the device.
+ *
  * A signal is emitted whenever the orientation changes.
  * Dali applications have full control over visual layout when the device is rotated
  * i.e. the application developer decides which UI controls to rotate, if any.
@@ -49,16 +51,17 @@ class Orientation : public BaseHandle
 {
 public:
 
-  typedef SignalV2< void (Orientation) > OrientationSignalV2;
+  typedef SignalV2< void (Orientation) > OrientationSignalV2; ///< Orientation changed signal type
 
   /**
-   * Create an unintialized handle. This can be initialized by calling
-   * Dali::Application::GetOrientation()
+   * @brief Create an unintialized handle.
+   *
+   * This can be initialized by calling Dali::Application::GetOrientation()
    */
   Orientation();
 
   /**
-   * Virtual Destructor
+   * @brief Virtual Destructor
    */
   virtual ~Orientation();
 
@@ -69,7 +72,8 @@ public:
 
 
   /**
-   * Returns the orientation of the device in degrees.
+   * @brief Returns the orientation of the device in degrees.
+   *
    * This is one of four discrete values, in degrees clockwise: 0, 90, 180, & 270
    * For a device with a portrait form-factor:
    *   0 indicates that the device is in the "normal" portrait orientation.
@@ -79,7 +83,8 @@ public:
   int GetDegrees() const;
 
   /**
-   * Returns the orientation of the device in radians.
+   * @brief Returns the orientation of the device in radians.
+   *
    * This is one of four discrete values, in radians clockwise: 0, PI/2, PI, & 3xPI/2
    * For a device with a portrait form-factor:
    *   0 indicates that the device is in the "normal" portrait orientation.
@@ -89,15 +94,17 @@ public:
   float GetRadians() const;
 
   /**
-   * The user should connect to this signal so that they can be notified whenever
+   * @brief The user should connect to this signal so that they can be notified whenever
    * the orientation of the device changes.
+   *
    * @return The orientation change signal.
    */
   OrientationSignalV2& ChangedSignal();
 
 public: // Not intended for application developers
   /**
-   * This constructor is used by Dali::Application::GetOrientation().
+   * @brief This constructor is used by Dali::Application::GetOrientation().
+   *
    * @param[in] orientation A pointer to the orientation object
    */
   explicit DALI_INTERNAL Orientation( Internal::Adaptor::Orientation* orientation );