From: Seoyeon Kim Date: Mon, 29 May 2017 09:40:41 +0000 (+0900) Subject: Fix API reference documentation X-Git-Tag: nui_0.2.41~3 X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=refs%2Fchanges%2F37%2F131837%2F1;p=platform%2Fcore%2Fcsapi%2Fnui.git Fix API reference documentation - Match the documentation with the parameter name - Remove the mention of internal API : View.GetTargetSize - Add documentation - merge from tizen branch Conflicts: Tizen.NUI/src/internal/DaliEnumConstants.cs Change-Id: I268d3a04021a5b4777de52042cf793639b458402 Signed-off-by: Seoyeon Kim --- diff --git a/Tizen.NUI/src/internal/DaliEnumConstants.cs b/Tizen.NUI/src/internal/DaliEnumConstants.cs index 8c154b4..a64c3a1 100755 --- a/Tizen.NUI/src/internal/DaliEnumConstants.cs +++ b/Tizen.NUI/src/internal/DaliEnumConstants.cs @@ -17,22 +17,27 @@ using System; namespace Tizen.NUI { - - namespace Constants + namespace Constants + { + /// + /// Enumeration for texture types. + /// + public enum TextureType { - public enum TextureType - { - Texture2D = Tizen.NUI.TextureType.TEXTURE_2D, ///< One 2D image @SINCE_1_1.43 - TextureCube = Tizen.NUI.TextureType.TEXTURE_CUBE ///< Six 2D images arranged in a cube-shape @SINCE_1_1.43 - } + Texture2D = Tizen.NUI.TextureType.TEXTURE_2D, ///< One 2D image + TextureCube = Tizen.NUI.TextureType.TEXTURE_CUBE ///< Six 2D images arranged in a cube-shape + } - public enum ViewMode - { - Mono = Tizen.NUI.ViewMode.MONO, ///< Monoscopic (single camera). This is the default @SINCE_1_0.0 - StereoHorizontal = Tizen.NUI.ViewMode.STEREO_HORIZONTAL, ///< Stereoscopic. Frame buffer is split horizontally with the left and right camera views in their respective sides. @SINCE_1_0.0 - StereoVertical = Tizen.NUI.ViewMode.STEREO_VERTICAL, ///< Stereoscopic. Frame buffer is split vertically with the left camera view at the top and the right camera view at the bottom. @SINCE_1_0.0 - StereoInterlaced = Tizen.NUI.ViewMode.STEREO_INTERLACED ///< @DEPRECATED_1_1.19 @brief Stereoscopic. Left/Right camera views are rendered into the framebuffer on alternate frames. @SINCE_1_0.0 - } + /// + /// Enumeration for stereoscopic view modes. + /// + public enum ViewMode + { + Mono = Tizen.NUI.ViewMode.MONO, ///< Monoscopic (single camera). This is the default. + StereoHorizontal = Tizen.NUI.ViewMode.STEREO_HORIZONTAL, ///< Stereoscopic. Frame buffer is split horizontally with the left and right camera views in their respective sides. + StereoVertical = Tizen.NUI.ViewMode.STEREO_VERTICAL, ///< Stereoscopic. Frame buffer is split vertically with the left camera view at the top and the right camera view at the bottom. + StereoInterlaced = Tizen.NUI.ViewMode.STEREO_INTERLACED ///< Stereoscopic. Left/Right camera views are rendered into the framebuffer on alternate frames. + } public struct Direction { diff --git a/Tizen.NUI/src/internal/dotnetcore/AddedException.cs b/Tizen.NUI/src/internal/dotnetcore/AddedException.cs index 5e05865..ddde060 100755 --- a/Tizen.NUI/src/internal/dotnetcore/AddedException.cs +++ b/Tizen.NUI/src/internal/dotnetcore/AddedException.cs @@ -1,18 +1,18 @@ -/** Copyright (c) 2017 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. -* -*/ +// Copyright (c) 2017 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. +// +// namespace System { diff --git a/Tizen.NUI/src/public/BaseComponents/CustomView.cs b/Tizen.NUI/src/public/BaseComponents/CustomView.cs index 69585f5..89f77c2 100644 --- a/Tizen.NUI/src/public/BaseComponents/CustomView.cs +++ b/Tizen.NUI/src/public/BaseComponents/CustomView.cs @@ -402,7 +402,7 @@ namespace Tizen.NUI.BaseComponents /// /// Called when the owning view's size is set e.g. using View.SetSize(). /// - /// The target size. Note that this target size may not match the size returned via View.GetTargetSize + /// The target size public virtual void OnSizeSet(Vector3 targetSize) { } @@ -411,7 +411,7 @@ namespace Tizen.NUI.BaseComponents /// Called when the owning view's size is animated e.g. using Animation::AnimateTo( Property( view, View::Property::SIZE ), ... ). /// /// The object which is animating the owning view - /// The target size. Note that this target size may not match the size returned via @ref View.GetTargetSize + /// The target size public virtual void OnSizeAnimation(Animation animation, Vector3 targetSize) { } diff --git a/Tizen.NUI/src/public/Timer.cs b/Tizen.NUI/src/public/Timer.cs index 04525be..90a6b24 100755 --- a/Tizen.NUI/src/public/Timer.cs +++ b/Tizen.NUI/src/public/Timer.cs @@ -139,7 +139,7 @@ namespace Tizen.NUI /// /// Creates a tick Timer that emits periodic signal. /// - /// Interval in milliseconds + /// Interval in milliseconds /// A new timer public Timer(uint milliSec) : this(NDalicPINVOKE.Timer_New(milliSec), true) { diff --git a/Tizen.NUI/src/public/UIComponents/Popup.cs b/Tizen.NUI/src/public/UIComponents/Popup.cs index 0e89e6b..d451c38 100755 --- a/Tizen.NUI/src/public/UIComponents/Popup.cs +++ b/Tizen.NUI/src/public/UIComponents/Popup.cs @@ -478,7 +478,7 @@ namespace Tizen.NUI.UIComponents /// /// Sets a title for this Popup. /// - /// The actor to set a title + /// The actor to set a title public void SetTitle(View titleView) { NDalicPINVOKE.Popup_SetTitle(swigCPtr, View.getCPtr(titleView));