+++ /dev/null
-/*
- * Copyright (c) 2016 Samsung Electronics Co., Ltd All Rights Reserved
- *
- * 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.
- */
-
-/// <summary>
-/// The Tizen.Content.MediaContent namespace provides types used in the entire content service.
-/// The information about media items (i.e. image, audio, and video) are managed in the content database
-/// and operations that involve database require an active connection with the media content service.
-/// During media scanning, the media content service extracts the media information automatically. The media information
-/// includes basic file information like path, size, modified time, etc. and some metadata like ID3 tag, EXIF,
-/// thumbnail, etc. (thumbnail extracted only in the internal and the SD card storage.
-/// </summary>
-/// <remarks>The media content service does not manage hidden files.</remarks>
-namespace Tizen.Content.MediaContent { }
\ No newline at end of file
--- /dev/null
+---
+# Copyright (c) 2016 Samsung Electronics Co., Ltd All Rights Reserved
+#
+# 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.
+
+uid: Tizen.Content.MediaContent
+summary: *content
+remarks: The media content service does not manage hidden files.
+---
+The Tizen.Content.MediaContent namespace provides types used in the entire content service.
+The information about media items (i.e. image, audio, and video) are managed in the content database
+and operations that involve database require an active connection with the media content service.
+During media scanning, the media content service extracts the media information automatically. The media information
+includes basic file information like path, size, modified time, etc. and some metadata like ID3 tag, EXIF,
+thumbnail, etc. (thumbnail extracted only in the internal and the SD card storage.
+++ /dev/null
-/*
- * Copyright (c) 2017 Samsung Electronics Co., Ltd All Rights Reserved
- *
- * 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.
- */
-
-/// <summary>
-/// The Tizen.Context.AppHistory namespace provides classes to retrieve the user's application usage patterns.
-/// </summary>
-/// <remarks>
-/// The Tizen.Context.AppHistory namespace provides classes to retrieve the user's application usage patterns.
-/// </remarks>
-/// <since_tizen> 4 </since_tizen>
-namespace Tizen.Context.AppHistory {}
--- /dev/null
+---
+# Copyright (c) 2017 Samsung Electronics Co., Ltd All Rights Reserved
+#
+# 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.
+
+uid: Tizen.Context.AppHistory
+summary: The Tizen.Context.AppHistory namespace provides classes to retrieve the user's application usage patterns.
+sinceTizen: 4
+---
+++ /dev/null
-/**
-<summary>
-The Tizen.Location.Geofence namespace provides classes for virtual perimeter.
-</summary>
-
-<remarks>
-
-<h2>Overview</h2>
-<para>
-This API provides functions to set the gofence with a geopoint, MAC address of Wi-Fi, and Bluetooth address.
-Also, notifications on events like changing in service status are provided.<p/>
-
-There are two kinds of places and fences:<br/>
-- Public places and fences that are created by the MyPlace application can be used by all applications.<br/>
-- Private places and fences that are created by the specified application can be used by the same application.<p/>
-
-Notifications can be received about the following events:<br/>
-- Zone in when a device enters a specific area.<br/>
-- Zone out when a device exits a specific area.<br/>
-- Results and errors for each event requested to geofence module.<p/>
-
-The Geofence manager has the following properties:<br/>
-- The geofence type.<br/>
-- The status.<br/>
-- 'Service state change' callback
-</para>
-
-<h2>Related Features</h2>
-<para>To guarantee that the geofence application runs on a device with the geofence profile feature,
-declare the following feature requirements in the config file:<br/>
-http://tizen.org/feature/location<br/>
-http://tizen.org/feature/location.Geofence<br/>
-http://tizen.org/feature/location.wps
-</para>
-
-</remarks>
-*/
-namespace Tizen.Location.Geofence {}
--- /dev/null
+---
+uid: Tizen.Location.Geofence
+summary: The Tizen.Location.Geofence namespace provides classes for virtual perimeter.
+remarks: *content
+---
+## Overview
+This API provides functions to set the gofence with a geopoint, MAC address of Wi-Fi, and Bluetooth address.
+Also, notifications on events like changing in service status are provided.
+
+There are two kinds of places and fences:
+- Public places and fences that are created by the MyPlace application can be used by all applications.
+- Private places and fences that are created by the specified application can be used by the same application.
+
+Notifications can be received about the following events:
+- Zone in when a device enters a specific area.
+- Zone out when a device exits a specific area.
+- Results and errors for each event requested to geofence module.
+
+The Geofence manager has the following properties:
+- The geofence type.
+- The status.
+- 'Service state change' callback
+
+## Related Features
+To guarantee that the geofence application runs on a device with the geofence profile feature,
+declare the following feature requirements in the config file:
+* http://tizen.org/feature/location
+* http://tizen.org/feature/location.Geofence
+* http://tizen.org/feature/location.wps
+++ /dev/null
-/**
-<summary>
-The Tizen.Location namespace provides classes for obtaining information related to the geographical location.
-Notifications on events like service becoming enabled or disabled,
-new position data being available, and others can also be acquired.
-</summary>
-<remarks>
-<h2>Overview</h2>
-<para>The Tizen.Location namespace provides classes for obtaining information related to the geographical location.
-Notifications on events like service becoming enabled or disabled,
-new position data being available, and others can also be acquired.</para>
-<h2>Related Features</h2>
-<para>To guarantee that the location application runs on a device with the location profile feature,
-declare the following feature requirements in the config file:<br/>
-http://tizen.org/feature/location<br/>
-http://tizen.org/feature/location.gps<br/>
-http://tizen.org/feature/location.wps
-</para>
-</remarks>
-*/
-namespace Tizen.Location {}
--- /dev/null
+---
+uid: Tizen.Location
+remarks: *content
+---
+## Overview
+The Tizen.Location namespace provides classes for obtaining information related to the geographical location.
+Notifications on events like service becoming enabled or disabled,
+new position data being available, and others can also be acquired.
+
+## Related Features
+To guarantee that the location application runs on a device with the location profile feature,
+declare the following feature requirements in the config file:
+* http://tizen.org/feature/location
+* http://tizen.org/feature/location.gps
+* http://tizen.org/feature/location.wps
+++ /dev/null
-/**
-<summary>
-The Tizen.Maps namespace provides classes to get the information of Place, Geocoding, Route by querying,
-or to show them on the map view with interactive gestural interface.
-</summary>
-
-
-
-<remarks>
-
-<h2>Overview</h2>
-<para>
-Maps API provides a developer with a set of functions, helping to create Maps aware applications.<p/>
-
-Maps API comprises of following features:<br/>
-- Geocoding and reverse Geocoding<br/>
-- Discoverying Place information<br/>
-- Calculating Route<br/>
-- View
-</para>
-
-
-<para>
-Maps API allows a Developer to choose one of Map Providers which are being included as plugins.<p/>
-
-<para>
-<h3>Geocoding</h3>
-The Maps Geocoding API allows translating an address to its geographical
-location defined in terms of latitude and longitude; the input can be a
-qualified and structured address or a free-formed search text with full or
-partial address information.<p/>
-
-The example below shows a structured address:<br/>
- - housenumber=117,<br/>
- - street=Invaliden street<br/>
- - city=Berlin,<br/>
- - postalcode=10115,<br/>
- - country=Germany,<br/>
- - state=Berlin
-</para>
-
-
-<para>
-<h3>Reverse Geocoding</h3>
-The Maps Reverse Geocoding API allows to inverse translating a geographical
-location (longitude, latitude) to an address; it can be used to answer the
-question "Where am I?".
-</para>
-
-
-<para>
-<h3>Route</h3>
-The Maps Route API provides ways to calculate a route that defines a path
-between a start and a destination and may, optionally, pass through specific
-intermediate locations.<p/>
-
-Route Preferences:<br/>
- - Travel Mode (car, pedestrian, public transit, truck),<br/>
- - Optimization (fastest, shortest),<br/>
- - Avoid/Prefer Preferences (toll road, motorway, ferry, public transit,
- tunnel, dirt road, parks, car-pool lane).<br/>
- - Route Calculations<br/>
- - Way points and preferences as input values,<br/>
- - Route geometry and maneuver (instructions for guidance) as result values:
- Geometry consists of points that visually represent the determined route,
- Maneuver contains turn-by-turn instruction and position.
-</para>
-
-
-<para>
-<h3>Places</h3>
-The Maps Place API allows you to find place information.<p/>
-
-Place search<br/>
- - Depending on the location context, the number of relevant places might
- be large. Therefore this query may not only return places, but also
- suggestions for additional filter criteria that allow users to interactively
- refine the classes of places they are interested in.<br/>
- - Nearby Search: search for places within a specified area.
- You can refine your search request by supplying keywords, Name of Points
- of Interests, or Proximity.<br/>
- - Category Search: search for popular places for the given location context and matching the category filter criteria.
- You can refine your search request by specifying the categories of place you are searching for.<br/>
-Result item type of searching<br/>
- - ID, name, location, distance, URI, rating, category.<br/>
-Place information allows to fetch details about a place. The following place content is supported:<br/>
- - Base Attribute includes name, location, categories, contacts, ID, ratings, icon path,
- image content, review content, and editorial content.<br/>
- - Extended Attribute refers to opening hours, payment methods, annual closings, disabled access.
-</para>
-
-
-<para>
-<h3>View</h3>
-The Maps View API provides a developer with a set of functions, bringing
-basic interactive visual user interface in maps applications.<p/>
-
-View widget: Drawing a map image on the map port, the specified rectangular
-area of the maps application GUI.<p/>
-
-Zoom and rotation: Changing zoom and orientation of the view in response
-to user gestures, such as scrolling, tapping, zooming, rotating, etc.<p/>
-
-Conversion of screen coordinates to geographical and vice versa.<p/>
-
-User's gesture support:<br/>
- - Receive the event of the user gesture.<br/>
- - Enable or disable the specified gesture.<br/>
- - Re-assign the action, which should be taken in response to the user's gesture.<p/>
-
-Various Properties:<br/>
- - Visibility and size on the screen.<br/>
- - Theme: Day, satellite, or terrain.<br/>
- - Language: English, Russian, Chinese, Italian, German, Spanish, etc.
-</para>
-</para>
-
-
-
-<h2>Related Features</h2>
-<para>
-To guarantee that the Maps application runs on a device with Maps profile feature,
-declare the following feature requirements in the config file:<br/>
-http://tizen.org/feature/maps<br/>
-http://tizen.org/feature/internet
-</para>
-
-</remarks>
-*/
-
-namespace Tizen.Maps {}
-
--- /dev/null
+---
+uid: Tizen.Maps
+remarks: *content
+---
+## Overview
+
+Maps API provides a developer with a set of functions, helping to create Maps aware applications.
+
+Maps API comprises of following features:
+- [Geocoding](#geocoding) and [reverse Geocoding](#reverse-geocoding)
+- Discoverying [place](#places) information
+- Calculating [route](#route)
+- [View](#view)
+
+Maps API allows a Developer to choose one of Map Providers which are being included as plugins.
+
+### Geocoding
+
+The [Maps Geocoding](xref:Tizen.Maps.GeocodeRequest) API allows translating an address to its geographical
+location defined in terms of latitude and longitude; the input can be a
+qualified and structured address or a free-formed search text with full or
+partial address information.
+
+The example below shows a structured address:
+ - housenumber=117,
+ - street=Invaliden street
+ - city=Berlin,
+ - postalcode=10115,
+ - country=Germany,
+ - state=Berlin
+
+
+### Reverse Geocoding
+
+The [Maps Reverse Geocoding](xref:Tizen.Maps.ReverseGeocodeRequest) API allows to inverse translating a geographical
+location (longitude, latitude) to an address; it can be used to answer the
+question "Where am I?".
+
+
+### Route
+
+The [Maps Route](xref:Tizen.Maps.Route) API provides ways to calculate a route that defines a path
+between a start and a destination and may, optionally, pass through specific
+intermediate locations.
+
+Route Preferences:
+ - Travel Mode (car, pedestrian, public transit, truck),
+ - Optimization (fastest, shortest),
+ - Avoid/Prefer Preferences (toll road, motorway, ferry, public transit,
+ tunnel, dirt road, parks, car-pool lane).
+ - Route Calculations
+ - Way points and preferences as input values,
+ - Route geometry and maneuver (instructions for guidance) as result values:
+ Geometry consists of points that visually represent the determined route,
+ Maneuver contains turn-by-turn instruction and position.
+
+
+### Places
+
+The [Maps Place](xref:Tizen.Maps.Place) API allows you to find place information.
+
+Place search
+ - Depending on the location context, the number of relevant places might
+ be large. Therefore this query may not only return places, but also
+ suggestions for additional filter criteria that allow users to interactively
+ refine the classes of places they are interested in.
+ - Nearby Search: search for places within a specified area.
+ You can refine your search request by supplying keywords, Name of Points
+ of Interests, or Proximity.
+ - Category Search: search for popular places for the given location context and matching the category filter criteria.
+ You can refine your search request by specifying the categories of place you are searching for.
+Result item type of searching
+ - ID, name, location, distance, URI, rating, category.
+Place information allows to fetch details about a place. The following place content is supported:
+ - Base Attribute includes name, location, categories, contacts, ID, ratings, icon path,
+ image content, review content, and editorial content.
+ - Extended Attribute refers to opening hours, payment methods, annual closings, disabled access.
+
+
+### View
+The [Maps View](xref:Tizen.Maps.MapView) API provides a developer with a set of functions, bringing
+basic interactive visual user interface in maps applications.
+
+View widget: Drawing a map image on the map port, the specified rectangular
+area of the maps application GUI.
+
+Zoom and rotation: Changing zoom and orientation of the view in response
+to user gestures, such as scrolling, tapping, zooming, rotating, etc.
+
+Conversion of screen coordinates to geographical and vice versa.
+
+User's gesture support:
+ - Receive the event of the user gesture.
+ - Enable or disable the specified gesture.
+ - Re-assign the action, which should be taken in response to the user's gesture.
+
+Various Properties:
+ - Visibility and size on the screen.
+ - Theme: Day, satellite, or terrain.
+ - Language: English, Russian, Chinese, Italian, German, Spanish, etc.
+
+
+### Related Features
+To guarantee that the Maps application runs on a device with Maps profile feature,
+declare the following feature requirements in the config file:
+* http://tizen.org/feature/maps
+* http://tizen.org/feature/internet
+++ /dev/null
-/*
- * Copyright (c) 2016 Samsung Electronics Co., Ltd All Rights Reserved
- *
- * 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 Tizen.Messaging.Email
-{
- /// <summary>
- /// The <b>Tizen.Messaging.Email</b> namespace contains classes providing the functionality to send emails.
- /// </summary>
- /// <remarks>
- /// The <b>Tizen.Messaging.Email</b> namespace contains classes providing the functionality to send emails.
- /// </remarks>
-}
+++ /dev/null
-/*
- * Copyright (c) 2016 Samsung Electronics Co., Ltd All Rights Reserved
- *
- * 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 Tizen.Messaging.Messages
-{
- /// <summary>
- /// The <b>Tizen.Messaging.Messages</b> namespace contains classes providing the functionality to send, receive, and search messages.
- /// </summary>
- /// <remarks>
- /// The <b>Tizen.Messaging.Messages</b> namespace contains classes providing the functionality to send, receive, and search messages.
- /// </remarks>
-}
\ No newline at end of file
--- /dev/null
+---
+# Copyright (c) 2016 Samsung Electronics Co., Ltd All Rights Reserved
+#
+# 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.
+
+uid: Tizen.Messaging.Email
+summary: The Tizen.Messaging.Email namespace contains classes providing the functionality to send emails.
+---
--- /dev/null
+---
+# Copyright (c) 2016 Samsung Electronics Co., Ltd All Rights Reserved
+#
+# 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.
+
+uid: Tizen.Messaging.Messages
+summary: The Tizen.Messaging.Messages namespace contains classes providing the functionality to send, receive, and search messages.
+---
+++ /dev/null
-/*
- * Copyright (c) 2016 Samsung Electronics Co., Ltd All Rights Reserved
- *
- * 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.
- */
-
-/// <summary>
-/// The System.Runtime.Remoting namespace provides classes and interfaces that work with remote process or device.
-/// </summary>
-namespace Tizen.Multimedia.Remoting
-{
-}
\ No newline at end of file
--- /dev/null
+---
+# Copyright (c) 2016 Samsung Electronics Co., Ltd All Rights Reserved
+#
+# 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.
+
+uid: Tizen.Multimedia.Remoting
+summary: The System.Runtime.Remoting namespace provides classes and interfaces that work with remote process or device.
+---
+++ /dev/null
-/*
- * Copyright (c) 2016 Samsung Electronics Co., Ltd All Rights Reserved
- *
- * 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.
- */
-
-/// <summary>
-/// The Tizen.Multimedia.Vision namespace contains classes and interfaces that support vision processing including
-/// face detection, face recognition, face tracking, barcode detection, barcode generation, flat image detection,
-/// flat image recognition, flat image tracking, flat image features extraction, movement detection,
-/// person appearance/disappearance detection and person recognition.
-/// </summary>
-namespace Tizen.Multimedia.Vision
-{
-}
--- /dev/null
+---
+# Copyright (c) 2016 Samsung Electronics Co., Ltd All Rights Reserved
+#
+# 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.
+
+uid: Tizen.Multimedia.Vision
+summary: *content
+---
+The Tizen.Multimedia.Vision namespace contains classes and interfaces that support vision processing including
+face detection, face recognition, face tracking, barcode detection, barcode generation, flat image detection,
+flat image recognition, flat image tracking, flat image features extraction, movement detection,
+person appearance/disappearance detection and person recognition.
+++ /dev/null
-/**
-<summary>
-The Tizen.Network.IoTConnectivity namespace provides classes to manage
-Resource, RemoteResource, Request, Response and so on which are based on IoTivity project.
-</summary>
-<remarks>
-The Tizen.Network.IoTConnectivity namespace provides classes to manage
-Resource, RemoteResource, Request, Response and so on which are based on IoTivity project.
-</remarks>
-*/
-namespace Tizen.Network.IoTConnectivity {}
-
--- /dev/null
+---
+uid: Tizen.Network.IoTConnectivity
+summary: *content
+---
+The Tizen.Network.IoTConnectivity namespace provides classes to manage
+Resource, RemoteResource, Request, Response and so on which are based on IoTivity project.
+++ /dev/null
-/**
-<summary>
-The Tizen.Network.Mtp namespace provides classes to manage the MTP(Media Transfer Protocol) initiator.
-</summary>
-
-<remarks>
-
-<h2>Overview</h2>
-<para>
-MTP API provides functions for support PTP(Picture Transfer Protocol) subset of MTP(Media Transfer Protocol).
-</para>
-
-<para>
-<h3>Manager</h3>
-Provide functions to establish connection to access MTP responder device, and to Get/Delete files.
-</para>
-
-<para>
-<h3>Device</h3>
-Provide functions to gets the device information of MTP responder device.
-</para>
-
-<para>
-<h3>Storage</h3>
-Provide functions to gets the storage information of MTP responder storage.
-</para>
-
-<para>
-<h3>Object</h3>
-Provide functions to gets the object information of certain file in MTP responder.
-</para>
-
-<h2>Related Features</h2>
-<para>
-To guarantee that if input or output path are relevant to internal and external storage,
-declare the following feature requirements in the config file:<br/>
-http://tizen.org/privilege/mediastorage
-http://tizen.org/privilege/externalstorage
-</para>
-
-</remarks>
-*/
-
-namespace Tizen.Network.Mtp { }
\ No newline at end of file
--- /dev/null
+---
+uid: Tizen.Network.Mtp
+summary: The Tizen.Network.Mtp namespace provides classes to manage the MTP(Media Transfer Protocol) initiator.
+remarks: *content
+---
+## Overview
+MTP API provides functions for support PTP(Picture Transfer Protocol) subset of MTP(Media Transfer Protocol).
+
+### Manager
+Provide functions to establish connection to access MTP responder device, and to Get/Delete files.
+
+### Device
+Provide functions to gets the device information of MTP responder device.
+
+### Storage
+Provide functions to gets the storage information of MTP responder storage.
+
+### Object
+Provide functions to gets the object information of certain file in MTP responder.
+
+
+## Related Features
+To guarantee that if input or output path are relevant to internal and external storage,
+declare the following feature requirements in the config file:
+* http://tizen.org/privilege/mediastorage
+* http://tizen.org/privilege/externalstorage
+++ /dev/null
-/**
-<summary>
-The Tizen.Network.Nsd namespace provides classes to manage the network service discovery protocols.
-</summary>
-<remarks>
-<h2>Overview</h2>
-<para>The Nsd API handles two network service discovery protocols: DNS-SD (DNS Service Discovery) and SSDP (Simple Service Discovery Protocol). They allows application to announce local services and search for remote services on a network.
-</para>
-<h2>Related Features</h2>
-<para>To use DNS-SD, declare the following feature requirements in the config file:<br/>
-http://tizen.org/feature/network.service_discovery.dnssd
-</para>
-<para>To use SSDP, declare the following feature requirements in the config file:<br/>
-http://tizen.org/feature/network.service_discovery.ssdp
-</para>
-
-</remarks>
-
-<example>
-The following example demonstrates how to register a DNS-SD local service.
-<code>
-DnssdService service = new DnssdService("_http._tcp");
-service.Name = "TestService";
-service.Port = "1234";
-service.RegisterService();
-</code>
-</example>
-
-*/
-namespace Tizen.Network.Nsd {}
--- /dev/null
+---
+uid: Tizen.Network.Nsd
+summary: The Tizen.Network.Nsd namespace provides classes to manage the network service discovery protocols.
+remarks: *content
+---
+## Overview
+The Nsd API handles two network service discovery protocols: DNS-SD (DNS Service Discovery) and SSDP (Simple Service Discovery Protocol). They allows application to announce local services and search for remote services on a network.
+
+
+## Example
+The following example demonstrates how to register a DNS-SD local service.
+```cs
+DnssdService service = new DnssdService("_http._tcp");
+service.Name = "TestService";
+service.Port = "1234";
+service.RegisterService();
+```
+
+
+## Related Features
+To use DNS-SD, declare the following feature requirements in the config file:
+http://tizen.org/feature/network.service_discovery.dnssd
+
+To use SSDP, declare the following feature requirements in the config file:
+http://tizen.org/feature/network.service_discovery.ssdp
+++ /dev/null
-/// <summary>
-/// The Tizen.Network.WiFiDirect namespace provides classes to manage the settings of Wi-Fi Direct.
-/// In addition, this namespace provides classes to connect and disconnect remote devices using Wi-Fi Direct.
-/// </summary>
-namespace Tizen.Network.WiFiDirect {}
--- /dev/null
+---
+uid: Tizen.Network.WiFiDirect
+summary: *content
+---
+The Tizen.Network.WiFiDirect namespace provides classes to manage the settings of Wi-Fi Direct.
+In addition, this namespace provides classes to connect and disconnect remote devices using Wi-Fi Direct.
+++ /dev/null
-/*
- * Copyright (c) 2016 Samsung Electronics Co., Ltd All Rights Reserved
- *
- * 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 Tizen.PhonenumberUtils
-{
- /// <summary>
- /// The Tizen.PhonenumberUtils namespace provides a class for parsing, formatting and normalizing phone numbers.
- /// </summary>
- /// <remarks>
- /// The Tizen.PhonenumberUtils namespace provides a class for parsing, formatting and normalizing phone numbers.
- /// </remarks>
- /// <since_tizen> 4 </since_tizen>
-}
--- /dev/null
+---
+# Copyright (c) 2016 Samsung Electronics Co., Ltd All Rights Reserved
+#
+# 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.
+
+uid: Tizen.PhonenumberUtils
+summary: The Tizen.PhonenumberUtils namespace provides a class for parsing, formatting and normalizing phone numbers.
+sinceTizen: 4
+---
+++ /dev/null
-/*
- * Copyright (c) 2016 Samsung Electronics Co., Ltd All Rights Reserved
- *
- * 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 Tizen.Pims.Calendar
-{
- /// <summary>
- /// The Tizen.Pims.Calendar namespace provides classes for managing calendar information for schedule.
- /// </summary>
- /// <remarks>
- /// The Tizen.Pims.Calendar namespace provides classes for managing calendar information for schedule.
- /// </remarks>
- /// <since_tizen> 4 </since_tizen>
-}
-
--- /dev/null
+---
+# Copyright (c) 2016 Samsung Electronics Co., Ltd All Rights Reserved
+#
+# 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.
+
+uid: Tizen.Pims.Calendar
+summary: The Tizen.Pims.Calendar namespace provides classes for managing calendar information for schedule.
+sinceTizen: 4
+---
+++ /dev/null
-/*
- * Copyright (c) 2016 Samsung Electronics Co., Ltd All Rights Reserved
- *
- * 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 Tizen.Pims.Contacts
-{
- /// <summary>
- /// The Tizen.Pims.Contacts namespace provides classes for managing contact information for people.
- /// </summary>
- /// <remarks>
- /// The Tizen.Pims.Contacts namespace provides classes for managing contact information for people.
- /// </remarks>
- /// <since_tizen> 4 </since_tizen>
-}
\ No newline at end of file
--- /dev/null
+---
+# Copyright (c) 2016 Samsung Electronics Co., Ltd All Rights Reserved
+#
+# 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.
+
+uid: Tizen.Pims.Contacts
+summary: The Tizen.Pims.Contacts namespace provides classes for managing contact information for people.
+sinceTizen: 4
+---
+++ /dev/null
-/**
-<summary>
-Secure Repository function is provided by key-manager module in Tizen. The key manager provides a secure repository for keys, certificates, and sensitive data related to users and their password-protected APPs. Additionally, it provides secure cryptographic operations for non-exportable keys without revealing the key values to clients.
-</summary>
-
-<remarks>
-<h2>Overview</h2>
-<para>
-Secure Repository stores keys, certificates, and sensitive user data in a central secure repository. The central secure repository is protected by a password.
-</para>
-
-<para>
-Data Store Policy
-A client can specify simple access rules when storing data in the key manager:
- Extractable or non-extractable
- - Only for data tagged as extractable, the key manager returns the raw value of the data.
- - If data is tagged as non-extractable, the key manager does not return its raw value. In that case, the key manager provides secure cryptographic operations for non-exportable keys without revealing the key values to the clients.
- Per key password
- - All data in the key manager is protected by a user password.
- - A client can encrypt its data using their own password additionally.
- - If a client provides a password when storing data, the data is encrypted with the password. This password must be provided when getting the data from the key manager.
-</para>
-
-<para>
-Data Access Control
- By default, only the owner of a data can access to the data.
- If the owner grants the access to other applications, those applications can read or delete the data from key-manager DB.
- When an application is deleted, the data and access control information granted by the application are also removed.
-</para>
-
-<para>
-Alias Format
- The format of alias is "package_id name" and the name should not contain any white space characters.
- If package_id is not provided by a client, the key-manager will add the package_id of the client to the name internally.
- The client can specify only its own pacakge id in the alias when storing a key, certificate, or data.
- A client should specify the pacakge id of the owner in the alias to retrieve a a key, certificate, or data shared by other applications.
- Aliases are returned from the key-manager as the format of package_id name.
-</para>
-</remarks>
-*/
-namespace Tizen.Security.SecureRepository {}
--- /dev/null
+---
+uid: Tizen.Security.SecureRepository
+summary: Secure Repository function is provided by key-manager module in Tizen. The key manager provides a secure repository for keys, certificates, and sensitive data related to users and their password-protected APPs. Additionally, it provides secure cryptographic operations for non-exportable keys without revealing the key values to clients.
+remarks: *content
+---
+## Overview
+Secure Repository stores keys, certificates, and sensitive user data in a central secure repository. The central secure repository is protected by a password.
+
+### Data Store Policy
+A client can specify simple access rules when storing data in the key manager:
+
+* Extractable or non-extractable
+ - Only for data tagged as extractable, the key manager returns the raw value of the data.
+ - If data is tagged as non-extractable, the key manager does not return its raw value. In that case, the key manager provides secure cryptographic operations for non-exportable keys without revealing the key values to the clients.
+* Per key password
+ - All data in the key manager is protected by a user password.
+ - A client can encrypt its data using their own password additionally.
+ - If a client provides a password when storing data, the data is encrypted with the password. This password must be provided when getting the data from the key manager.
+
+### Data Access Control
+ - By default, only the owner of a data can access to the data.
+ - If the owner grants the access to other applications, those applications can read or delete the data from key-manager DB.
+ - When an application is deleted, the data and access control information granted by the application are also removed.
+
+### Alias Format
+ - The format of alias is "package_id name" and the name should not contain any white space characters.
+ - If package_id is not provided by a client, the key-manager will add the package_id of the client to the name internally.
+ - The client can specify only its own pacakge id in the alias when storing a key, certificate, or data.
+ - A client should specify the pacakge id of the owner in the alias to retrieve a a key, certificate, or data shared by other applications.
+ - Aliases are returned from the key-manager as the format of package_id name.
-/**
-<summary>
-The communication API for connecting Client Applications running in a rich operating environment
-with security related Trusted Applications running inside a Trusted Execution Environment (TEE).
-</summary>
-
-<remarks>
-<h2>Overview</h2>
-<para>
+---
+uid: Tizen.Security.TEEC
+summary: The communication API for connecting Client Applications running in a rich operating environment
+ with security related Trusted Applications running inside a Trusted Execution Environment (TEE).
+remarks: *content
+---
+## Overview
A TEE provides an execution environment with security capabilities, which are either available to Trusted Applications
running inside the TEE or exposed externally to Client Applications.
The TEE Client API concentrates on the interface to enable efficient communications between
provided by the TEE Client API – for example, to cover common tasks, such as secure storage,
cryptography, and run-time installation of new Trusted Applications.
The separation between the rich environment and the TEE is guaranted.
-</para>
-<para>
+
The key design principles of the TEE Client API are:
-<list type="bullet">
-<item>
- <term>Client-side memory allocations</term>
- <description>
+ * Client-side memory allocations
Where possible the design of the TEE Client API has placed the responsibility for memory
allocation on the calling Client Application code. This gives the Client developer choice of
memory allocation locations, enabling simple optimizations, such as stack-based allocation
- or enhanced flexibility using placements in static global memory or thread-local storage.<br />
+ or enhanced flexibility using placements in static global memory or thread-local storage.
+
This design choice is evident in the API by the use of pointers to structures rather than
opaque handles to represent any manipulated objects.
- </description>
-</item>
-<item>
- <term>Aim for zero-copy data transfer</term>
- <description>
+ * Aim for zero-copy data transfer
The features of the TEE Client API are chosen to maximize the possibility of zero-copy
- data transfer between the Client Application and the Trusted Application.<br />
+ data transfer between the Client Application and the Trusted Application.
However, short messages can also be passed by copy, which avoids the overhead of
sharing memory.
- </description>
-</item>
-<item>
- <term>Support memory sharing by pointers</term>
- <description>
+ * Support memory sharing by pointers
The TEE Client API will be used to implement higher-level APIs, such as cryptography or
secure storage, where the caller will often provide memory buffers for input or output data
using simple C pointers. The TEE Client API must allow efficient sharing of this type of
memory, and as such does not rely on the Client Application being able to use bulk
memory buffers allocated by the TEE Client API.
- </description>
-</item>
-<item>
- <term>Specify only communication mechanisms</term>
- <description>
+ * Specify only communication mechanisms
This API focuses on defining the underlying communications channel. It does not define
the format of the messages which pass over the channel, or the protocols used by specific
Trusted Applications.
- </description>
-</item>
-</list>
-</para>
-</remarks>
-
-<example>
+## Example
The following example demonstrates how to invoke command on Trused Application.
-<code>
- Guid ta_uuid = new Guid("TA-guid-put-here");
- Context ctx = new Context(null);
- Session ses = ctx.OpenSession(ta_uuid);
- Parameter[] p = { new Value(1,2,TEFValueType.In) };
- ses.InvokeCommand(1, p);
- ses.Close();
- ctx.Dispose();
-</code>
-</example>
-*/
-namespace Tizen.Security.TEEC {}
+
+```cs
+Guid ta_uuid = new Guid("TA-guid-put-here");
+Context ctx = new Context(null);
+Session ses = ctx.OpenSession(ta_uuid);
+Parameter[] p = { new Value(1,2,TEFValueType.In) };
+ses.InvokeCommand(1, p);
+ses.Close();
+ctx.Dispose();
+```
projects / platform / core / csapi / tizenfx.git / commitdiff