From 5e88228d70bab2fea5baff3c9d9e29904fbc2840 Mon Sep 17 00:00:00 2001 From: WonYoung Choi Date: Mon, 22 Jun 2020 10:43:59 +0900 Subject: [PATCH] [Docs] Update documentation files (#1726) - Modify description of first page - Apply material designs - Apply wide layouts - Apply Tizen.DocFX.Plugins to provide tizen-specific tags. --- docs/api/index.md | 2 +- docs/docfx.json | 11 +- docs/index.md | 25 +- docs/template/ManagedReference.common.js | 264 ------------------ docs/template/ManagedReference.extension.js | 27 -- docs/template/RestApi.common.js | 298 -------------------- docs/template/partials/namespace.tmpl.partial | 21 -- docs/template/styles/main.css | 10 - docs/templates/material/LICENSE | 21 ++ docs/templates/material/partials/head.tmpl.partial | 21 ++ docs/templates/material/styles/main.css | 299 +++++++++++++++++++++ docs/{template => templates/tizen}/favicon.ico | Bin docs/templates/tizen/partials/affix.tmpl.partial | 20 ++ .../tizen}/partials/class.header.tmpl.partial | 30 +-- .../tizen}/partials/class.tmpl.partial | 51 ++-- .../tizen}/partials/footer.tmpl.partial | 0 docs/templates/tizen/partials/head.tmpl.partial | 20 ++ .../tizen}/partials/logo.tmpl.partial | 0 .../Tizen.DocFX.Plugins.MetadataProvider.dll | Bin 0 -> 13312 bytes docs/templates/tizen/styles/tizen.css | 38 +++ docs/{template => templates/tizen}/token.json | 6 +- docs/toc.yml | 2 +- .../ElmSharp/EcoreSynchronizationContext.cs | 8 +- src/Tizen.NUI/src/public/VisualConstants.cs | 1 + 24 files changed, 480 insertions(+), 695 deletions(-) delete mode 100644 docs/template/ManagedReference.common.js delete mode 100644 docs/template/ManagedReference.extension.js delete mode 100644 docs/template/RestApi.common.js delete mode 100644 docs/template/partials/namespace.tmpl.partial delete mode 100644 docs/template/styles/main.css create mode 100644 docs/templates/material/LICENSE create mode 100644 docs/templates/material/partials/head.tmpl.partial create mode 100644 docs/templates/material/styles/main.css rename docs/{template => templates/tizen}/favicon.ico (100%) create mode 100644 docs/templates/tizen/partials/affix.tmpl.partial rename docs/{template => templates/tizen}/partials/class.header.tmpl.partial (87%) rename docs/{template => templates/tizen}/partials/class.tmpl.partial (85%) rename docs/{template => templates/tizen}/partials/footer.tmpl.partial (100%) create mode 100644 docs/templates/tizen/partials/head.tmpl.partial rename docs/{template => templates/tizen}/partials/logo.tmpl.partial (100%) create mode 100644 docs/templates/tizen/plugins/Tizen.DocFX.Plugins.MetadataProvider.dll create mode 100644 docs/templates/tizen/styles/tizen.css rename docs/{template => templates/tizen}/token.json (93%) diff --git a/docs/api/index.md b/docs/api/index.md index 70f7a9b..0f97a9c 100644 --- a/docs/api/index.md +++ b/docs/api/index.md @@ -1,4 +1,4 @@ -## TizenFX API +## API Level 8 TizenFX API constists of the following namespaces: diff --git a/docs/docfx.json b/docs/docfx.json index 5521e7a..068e9b9 100644 --- a/docs/docfx.json +++ b/docs/docfx.json @@ -44,19 +44,18 @@ "globalMetadata": { "_appLogoPath" : "images/tizen_logo.png", "_appFaviconPath" : "images/tizen_favicon.ico", - "_appFooter" : "Copyright © 2016-2018 Samsung
Generated by DocFX", - "_disableAffix": false, - "_disableContribution": true, + "_appFooter" : "Copyright © 2016-2020 Samsung
Generated by DocFX", + "_disableAffix": false, + "_disableContribution": false, "_baseUrl": "https://samsung.github.io/TizenFX/master/", - "_newIssueUrl": "https://github.com/Samsung/TizenFX/issues/new", - "_docEditBaseUrl": "https://github.com/Samsung/TizenFX/edit/docs/", "_enableSearch" : "true" }, "dest": "../Artifacts/docs", "xrefService": [ "https://xref.docs.microsoft.com/query?uid={uid}" ], "template": [ "default", - "./template" + "./templates/material", + "./templates/tizen" ], "postProcessors": ["ExtractSearchIndex"], "noLangKeyword": false, diff --git a/docs/index.md b/docs/index.md index d2a5e22..c444ac3 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,20 +1,23 @@ -# Tizen .NET +## Tizen .NET -Tizen .NET provides a rich set of interfaces allowing you to build compelling TV, mobile and wearable(preview) applications which achieve native performance. The programming environment includes the following: +Tizen .NET is an exciting new way to develop applications for the Tizen operating system, running on 50 million Samsung devices, including TVs, wearables, mobile phones, and many other IoT devices around the world. -- .NET Standard API, which implements the .NET Base Class library, allows you to use the well known C# language base class libraries and features, such as collections, threading, file I/O, and LINQ. -- Xamarin.Forms, which allows you to efficiently build a user interface from standard components in C# or XAML. -- TizenFX API, which allows you to access platform-specific features not covered by the generic .NET and Xamarin.Forms features, such as system information and status, battery status, sensor date, and account and connectivity services. - For the full specification, see the [TizenFX API Reference.](api/index.md) +The existing Tizen frameworks are either C-based with no advantages of a managed runtime, or HTML5-based with fewer features and lower performance than the C-based solution. With Tizen .NET, you can use the C# programming language and the Common Language Infrastructure standards, and have benefits from a managed runtime for faster application development and code execution that is efficient and secure. -## .NET Standard API -One of the major components of .NET Core is the .NET Standard. The .NET APIs provided by Tizen .NET follow the .NET Standard 2.0. The column titled "2.0" in the [official list](https://docs.microsoft.com/en-us/dotnet/standard/net-standard) of supported CoreFX APIs lists all the available .NET APIs. +## TizenFX API -## Xamarin.Forms +TizenFX API allows applications to call into platform-specific functionality from the shared code. This functionality enables Xamarin.Forms applications to do things a native application can do, without causing the portable part of the application to become littered with operating system-specific details. -[Xamarin.Forms](https://developer.xamarin.com/guides/xamarin-forms/getting-started/) provides cross-platform APIs, which allow you to create user interfaces that can be shared across platforms. The Tizen.NET Visual Studio extension enables Tizen support for Xamarin.Forms. +The following table specifies the API Level supported by each version of the Tizen platform: + +| API Level | Target Framework | Target Platform | API Reference | +|-------------|------------------|-----------------|-----------------| +| API Level 8 | tizen80 | Tizen vNext | https://samsung.github.io/TizenFX/master/ | +| API Level 7 | tizen70 | Tizen 5.5 M3 | https://samsung.github.io/TizenFX/API7/ | +| API Level 6 | tizen60 | Tizen 5.5 M2 | https://samsung.github.io/TizenFX/API6/ | +| API Level 5 | tizen50 | Tizen 5.0 M2 | https://samsung.github.io/TizenFX/API5/ | +| API Level 4 | tizen40 | Tizen 4.0 M2 | https://samsung.github.io/TizenFX/API4/ | -You can efficiently build your Tizen .NET application UI and its supporting logic using the Xamarin.Forms APIs. Extended details for these APIs are available on the [Xamarin Web site](https://developer.xamarin.com/api/namespace/Xamarin.Forms/). [!include[TizenFX API](api/index.md)] diff --git a/docs/template/ManagedReference.common.js b/docs/template/ManagedReference.common.js deleted file mode 100644 index 4747772..0000000 --- a/docs/template/ManagedReference.common.js +++ /dev/null @@ -1,264 +0,0 @@ -// Copyright (c) Microsoft. All rights reserved. Licensed under the MIT license. See LICENSE file in the project root for full license information. -var common = require('./common.js'); -var classCategory = 'class'; -var namespaceCategory = 'ns'; - -exports.transform = function (model) { - - if (!model) return null; - - langs = model.langs; - handleItem(model, model._gitContribute, model._gitUrlPattern); - if (model.children) { - model.children.forEach(function (item) { - handleItem(item, model._gitContribute, model._gitUrlPattern); - }); - } - - if (model.type) { - switch (model.type.toLowerCase()) { - case 'namespace': - model.isNamespace = true; - if (model.children) groupChildren(model, namespaceCategory); - break; - case 'class': - case 'interface': - case 'struct': - case 'delegate': - case 'enum': - model.isClass = true; - if (model.children) groupChildren(model, classCategory); - model[getTypePropertyName(model.type)] = true; - break; - default: - break; - } - } - - return model; -} - -exports.getBookmarks = function (model, ignoreChildren) { - if (!model || !model.type || model.type.toLowerCase() === "namespace") return null; - - var bookmarks = {}; - - if (typeof ignoreChildren == 'undefined' || ignoreChildren === false) { - if (model.children) { - model.children.forEach(function (item) { - bookmarks[item.uid] = common.getHtmlId(item.uid); - if (item.overload && item.overload.uid) { - bookmarks[item.overload.uid] = common.getHtmlId(item.overload.uid); - } - }); - } - } - - // Reference's first level bookmark should have no anchor - bookmarks[model.uid] = ""; - return bookmarks; -} - -exports.groupChildren = groupChildren; -exports.getTypePropertyName = getTypePropertyName; -exports.getCategory = getCategory; - -function groupChildren(model, category) { - if (!model || !model.type) { - return; - } - var typeChildrenItems = getDefinitions(category); - var grouped = {}; - - model.children.forEach(function (c) { - if (c.isEii) { - var type = "eii"; - } else { - var type = c.type.toLowerCase(); - } - if (!grouped.hasOwnProperty(type)) { - grouped[type] = []; - } - // special handle for field - if (type === "field" && c.syntax) { - c.syntax.fieldValue = c.syntax.return; - c.syntax.return = undefined; - } - // special handle for property - if ((type === "property" || type === "attachedproperty") && c.syntax) { - c.syntax.propertyValue = c.syntax.return; - c.syntax.return = undefined; - } - // special handle for event - if ((type === "event" || type === "attachedevent") && c.syntax) { - c.syntax.eventType = c.syntax.return; - c.syntax.return = undefined; - } - grouped[type].push(c); - }) - - var children = []; - for (var key in typeChildrenItems) { - if (typeChildrenItems.hasOwnProperty(key) && grouped.hasOwnProperty(key)) { - var typeChildrenItem = typeChildrenItems[key]; - var items = grouped[key]; - if (items && items.length > 0) { - var item = {}; - for (var itemKey in typeChildrenItem) { - if (typeChildrenItem.hasOwnProperty(itemKey)) { - item[itemKey] = typeChildrenItem[itemKey]; - } - } - item.children = items; - children.push(item); - } - } - } - - model.children = children; -} - -function getTypePropertyName(type) { - if (!type) { - return undefined; - } - var loweredType = type.toLowerCase(); - var definition = getDefinition(loweredType); - if (definition) { - return definition.typePropertyName; - } - - return undefined; -} - -function getCategory(type) { - var classItems = getDefinitions(classCategory); - if (classItems.hasOwnProperty(type)) { - return classCategory; - } - - var namespaceItems = getDefinitions(namespaceCategory); - if (namespaceItems.hasOwnProperty(type)) { - return namespaceCategory; - } - return undefined; -} - -function getDefinition(type) { - var classItems = getDefinitions(classCategory); - if (classItems.hasOwnProperty(type)) { - return classItems[type]; - } - var namespaceItems = getDefinitions(namespaceCategory); - if (namespaceItems.hasOwnProperty(type)) { - return namespaceItems[type]; - } - return undefined; -} - -function getDefinitions(category) { - var namespaceItems = { - "class": { inClass: true, typePropertyName: "inClass", id: "classes" }, - "struct": { inStruct: true, typePropertyName: "inStruct", id: "structs" }, - "interface": { inInterface: true, typePropertyName: "inInterface", id: "interfaces" }, - "enum": { inEnum: true, typePropertyName: "inEnum", id: "enums" }, - "delegate": { inDelegate: true, typePropertyName: "inDelegate", id: "delegates" } - }; - var classItems = { - "constructor": { inConstructor: true, typePropertyName: "inConstructor", id: "constructors" }, - "field": { inField: true, typePropertyName: "inField", id: "fields" }, - "property": { inProperty: true, typePropertyName: "inProperty", id: "properties" }, - "attachedproperty": { inAttachedProperty: true, typePropertyName: "inAttachedProperty", id: "attachedProperties" }, - "method": { inMethod: true, typePropertyName: "inMethod", id: "methods" }, - "event": { inEvent: true, typePropertyName: "inEvent", id: "events" }, - "attachedevent": { inAttachedEvent: true, typePropertyName: "inAttachedEvent", id: "attachedEvents" }, - "operator": { inOperator: true, typePropertyName: "inOperator", id: "operators" }, - "eii": { inEii: true, typePropertyName: "inEii", id: "eii" } - }; - if (category === 'class') { - return classItems; - } - if (category === 'ns') { - return namespaceItems; - } - console.err("category '" + category + "' is not valid."); - return undefined; -} - -function handleItem(vm, gitContribute, gitUrlPattern) { - // get contribution information - vm.docurl = common.getImproveTheDocHref(vm, gitContribute, gitUrlPattern); - vm.sourceurl = common.getViewSourceHref(vm, null, gitUrlPattern); - - // set to null incase mustache looks up - vm.summary = vm.summary || null; - vm.remarks = vm.remarks || null; - //TIZEN - vm.sinceTizen = vm.sinceTizen || null; - vm.precondition = vm.precondition || null; - vm.postcondition = vm.postcondition || null; - vm.feature = vm.feature || null; - vm.privlevel = vm.privlevel || null; - vm.privilege = vm.privilege || null; - // - vm.conceptual = vm.conceptual || null; - vm.syntax = vm.syntax || null; - vm.implements = vm.implements || null; - vm.example = vm.example || null; - common.processSeeAlso(vm); - - // id is used as default template's bookmark - vm.id = common.getHtmlId(vm.uid); - if (vm.overload && vm.overload.uid) { - vm.overload.id = common.getHtmlId(vm.overload.uid); - } - - if (vm.supported_platforms) { - vm.supported_platforms = transformDictionaryToArray(vm.supported_platforms); - } - - if (vm.requirements) { - var type = vm.type.toLowerCase(); - if (type == "method") { - vm.requirements_method = transformDictionaryToArray(vm.requirements); - } else { - vm.requirements = transformDictionaryToArray(vm.requirements); - } - } - - if (vm && langs) { - if (shouldHideTitleType(vm)) { - vm.hideTitleType = true; - } else { - vm.hideTitleType = false; - } - - if (shouldHideSubtitle(vm)) { - vm.hideSubtitle = true; - } else { - vm.hideSubtitle = false; - } - } - - function shouldHideTitleType(vm) { - var type = vm.type.toLowerCase(); - return ((type === 'namespace' && langs.length == 1 && (langs[0] === 'objectivec' || langs[0] === 'java' || langs[0] === 'c')) - || ((type === 'class' || type === 'enum') && langs.length == 1 && langs[0] === 'c')); - } - - function shouldHideSubtitle(vm) { - var type = vm.type.toLowerCase(); - return (type === 'class' || type === 'namespace') && langs.length == 1 && langs[0] === 'c'; - } - - function transformDictionaryToArray(dic) { - var array = []; - for (var key in dic) { - if (dic.hasOwnProperty(key)) { - array.push({ "name": key, "value": dic[key] }) - } - } - - return array; - } -} \ No newline at end of file diff --git a/docs/template/ManagedReference.extension.js b/docs/template/ManagedReference.extension.js deleted file mode 100644 index 714f939..0000000 --- a/docs/template/ManagedReference.extension.js +++ /dev/null @@ -1,27 +0,0 @@ -// Copyright (c) Microsoft. All rights reserved. Licensed under the MIT license. See LICENSE file in the project root for full license information. - -/** - * This method will be called at the start of exports.transform in ManagedReference.html.primary.js - */ -exports.preTransform = function (model) { - function applyDefaultPrivilegeLevel(item) { - if (item.privilege && !item.privlevel) { - //console.log('Default "public" privilege for ' + item.uid); - item.privlevel = 'public'; - } - if (item.children) { - for (var i=0, len=item.children.length; i < len; i++) { - applyDefaultPrivilegeLevel(item.children[i]); - } - } - }; - applyDefaultPrivilegeLevel(model); - return model; -} - -/** - * This method will be called at the end of exports.transform in ManagedReference.html.primary.js - */ -exports.postTransform = function (model) { - return model; -} \ No newline at end of file diff --git a/docs/template/RestApi.common.js b/docs/template/RestApi.common.js deleted file mode 100644 index 509d6e5..0000000 --- a/docs/template/RestApi.common.js +++ /dev/null @@ -1,298 +0,0 @@ -// Copyright (c) Microsoft. All rights reserved. Licensed under the MIT license. See LICENSE file in the project root for full license information. -var common = require('./common.js'); - -exports.transform = function (model) { - var _fileNameWithoutExt = common.path.getFileNameWithoutExtension(model._path); - model._jsonPath = _fileNameWithoutExt + ".swagger.json"; - model.title = model.title || model.name; - model.docurl = model.docurl || common.getImproveTheDocHref(model, model._gitContribute, model._gitUrlPattern); - model.sourceurl = model.sourceurl || common.getViewSourceHref(model, null, model._gitUrlPattern); - model.htmlId = common.getHtmlId(model.uid); - if (model.children) { - for (var i = 0; i < model.children.length; i++) { - var child = model.children[i]; - child.docurl = child.docurl || common.getImproveTheDocHref(child, model._gitContribute, model._gitUrlPattern); - if (child.operation) { - child.operation = child.operation.toUpperCase(); - } - child.path = appendQueryParamsToPath(child.path, child.parameters); - child.sourceurl = child.sourceurl || common.getViewSourceHref(child, null, model._gitUrlPattern); - child.conceptual = child.conceptual || ''; // set to empty incase mustache looks up - child.summary = child.summary || ''; // set to empty incase mustache looks up - child.description = child.description || ''; // set to empty incase mustache looks up - child.footer = child.footer || ''; // set to empty incase mustache looks up - child.remarks = child.remarks || ''; // set to empty incase mustache looks up - //TIZEN - child.sinceTizen = child.sinceTizen || ''; - child.precondition = child.precondition || ''; - child.postcondition = child.postcondition || ''; - child.feature = child.feature || ''; - child.privlevel = child.privlevel || ''; - child.privilege = child.privilege || ''; - // - child.htmlId = common.getHtmlId(child.uid); - - formatExample(child.responses); - resolveAllOf(child); - transformReference(child); - }; - if (!model.tags || model.tags.length === 0) { - var childTags = []; - for (var i = 0; i < model.children.length; i++) { - var child = model.children[i]; - if (child.tags && child.tags.length > 0) { - for (var k = 0; k < child.tags.length; k++) { - // for each tag in child, add unique tag string into childTags - if (childTags.indexOf(child.tags[k]) === -1) { - childTags.push(child.tags[k]); - } - } - } - } - // sort alphabetically - childTags.sort(); - if (childTags.length > 0) { - model.tags = []; - for (var i = 0; i < childTags.length; i++) { - // add tags into model - model.tags.push({ "name": childTags[i] }); - } - } - } - if (model.tags) { - for (var i = 0; i < model.tags.length; i++) { - var children = getChildrenByTag(model.children, model.tags[i].name); - if (children) { - // set children into tag section - model.tags[i].children = children; - } - model.tags[i].conceptual = model.tags[i].conceptual || ''; // set to empty incase mustache looks up - if (model.tags[i]["x-bookmark-id"]) { - model.tags[i].htmlId = model.tags[i]["x-bookmark-id"]; - } else if (model.tags[i].uid) { - model.tags[i].htmlId = common.getHtmlId(model.tags[i].uid); - } - } - for (var i = 0; i < model.children.length; i++) { - var child = model.children[i]; - if (child.includedInTags) { - // set child to undefined, which is already moved to tag section - model.children[i] = undefined; - if (!model.isTagLayout) { - // flags to indicate the model is tag layout - model.isTagLayout = true; - } - } - } - // remove undefined child - model.children = model.children.filter(function (o) { return o; }); - } - } - - return model; - - function getChildrenByTag(children, tag) { - if (!children) return; - return children.filter(function (child) { - if (child.tags && child.tags.indexOf(tag) > -1) { - child.includedInTags = true; - return true; - } - }) - } - - function formatExample(responses) { - if (!responses) return; - for (var i = responses.length - 1; i >= 0; i--) { - var examples = responses[i].examples; - if (!examples) continue; - for (var j = examples.length - 1; j >= 0; j--) { - var content = examples[j].content; - if (!content) continue; - var mimeType = examples[j].mimeType; - if (mimeType === 'application/json') { - try { - var json = JSON.parse(content) - responses[i].examples[j].content = JSON.stringify(json, null, ' '); - } catch (e) { - console.warn("example is not a valid JSON object."); - } - } - } - } - } - - function resolveAllOf(obj) { - if (Array.isArray(obj)) { - for (var i = 0; i < obj.length; i++) { - resolveAllOf(obj[i]); - } - } - else if (typeof obj === "object") { - for (var key in obj) { - if (obj.hasOwnProperty(key)) { - if (key === "allOf" && Array.isArray(obj[key])) { - // find 'allOf' array and process - processAllOfArray(obj[key], obj); - // delete 'allOf' value - delete obj[key]; - } else { - resolveAllOf(obj[key]); - } - } - } - } - } - - function processAllOfArray(allOfArray, originalObj) { - // for each object in 'allOf' array, merge the values to those in the same level with 'allOf' - for (var i = 0; i < allOfArray.length; i++) { - var item = allOfArray[i]; - for (var key in item) { - if (originalObj.hasOwnProperty(key)) { - mergeObjByKey(originalObj[key], item[key]); - } else { - originalObj[key] = item[key]; - } - } - } - } - - function mergeObjByKey(targetObj, sourceObj) { - for (var key in sourceObj) { - // merge only when target object doesn't define the key - if (!targetObj.hasOwnProperty(key)) { - targetObj[key] = sourceObj[key]; - } - } - } - - function transformReference(obj) { - if (Array.isArray(obj)) { - for (var i = 0; i < obj.length; i++) { - transformReference(obj[i]); - } - } - else if (typeof obj === "object") { - for (var key in obj) { - if (obj.hasOwnProperty(key)) { - if (key === "schema") { - // transform schema.properties from obj to key value pair - transformProperties(obj[key]); - } else { - transformReference(obj[key]); - } - } - } - } - } - - function transformProperties(obj) { - if (obj.properties) { - if (obj.required && Array.isArray(obj.required)) { - for (var i = 0; i < obj.required.length; i++) { - var field = obj.required[i]; - if (obj.properties[field]) { - // add required field as property - obj.properties[field].required = true; - } - } - delete obj.required; - } - var array = []; - for (var key in obj.properties) { - if (obj.properties.hasOwnProperty(key)) { - var value = obj.properties[key]; - // set description to null incase mustache looks up - value.description = value.description || null; - - transformPropertiesValue(value); - array.push({ key: key, value: value }); - } - } - obj.properties = array; - } - } - - function transformPropertiesValue(obj) { - if (obj.type === "array" && obj.items) { - // expand array to transformProperties - obj.items.properties = obj.items.properties || null; - obj.items['x-internal-ref-name'] = obj.items['x-internal-ref-name'] || null; - obj.items['x-internal-loop-ref-name'] = obj.items['x-internal-loop-ref-name'] || null; - transformProperties(obj.items); - } else if (obj.properties && !obj.items) { - // fill obj.properties into obj.items.properties, to be rendered in the same way with array - obj.items = {}; - obj.items.properties = obj.properties || null; - delete obj.properties; - if (obj.required) { - obj.items.required = obj.required; - delete obj.required; - } - obj.items['x-internal-ref-name'] = obj['x-internal-ref-name'] || null; - obj.items['x-internal-loop-ref-name'] = obj['x-internal-loop-ref-name'] || null; - transformProperties(obj.items); - } - } - - function appendQueryParamsToPath(path, parameters) { - if (!path || !parameters) return path; - - var requiredQueryParams = parameters.filter(function (p) { return p.in === 'query' && p.required; }); - if (requiredQueryParams.length > 0) { - path = formatParams(path, requiredQueryParams, true); - } - - var optionalQueryParams = parameters.filter(function (p) { return p.in === 'query' && !p.required; }); - if (optionalQueryParams.length > 0) { - path += "["; - path = formatParams(path, optionalQueryParams, requiredQueryParams.length === 0); - path += "]"; - } - return path; - } - - function formatParams(path, parameters, isFirst) { - for (var i = 0; i < parameters.length; i++) { - if (i === 0 && isFirst) { - path += "?"; - } else { - path += "&"; - } - path += parameters[i].name; - } - return path; - } -} - -exports.getBookmarks = function (model) { - if (!model) return null; - - var bookmarks = {}; - - bookmarks[model.uid] = ""; - if (model.tags) { - model.tags.forEach(function (tag) { - if (tag.uid) { - bookmarks[tag.uid] = tag["x-bookmark-id"] ? tag["x-bookmark-id"] : common.getHtmlId(tag.uid); - } - if (tag.children) { - tag.children.forEach(function (child) { - if (child.uid) { - bookmarks[child.uid] = common.getHtmlId(child.uid); - } - }) - } - }) - } - if (model.children) { - model.children.forEach(function (child) { - if (child.uid) { - bookmarks[child.uid] = common.getHtmlId(child.uid); - } - }); - } - - return bookmarks; -} diff --git a/docs/template/partials/namespace.tmpl.partial b/docs/template/partials/namespace.tmpl.partial deleted file mode 100644 index 8cbc3e3..0000000 --- a/docs/template/partials/namespace.tmpl.partial +++ /dev/null @@ -1,21 +0,0 @@ -{{!Copyright (c) Microsoft. All rights reserved. Licensed under the MIT license. See LICENSE file in the project root for full license information.}} - -

{{>partials/title}}

-
{{{summary}}}
-
{{{conceptual}}}
-
{{{remarks}}}
-{{#sincetizen}} -
{{__global.sincetizen}}
-{{{sincetizen}}} -{{/sincetizen}} -{{#feature}} -
{{__global.feature}}
-
{{{feature}}}
-{{/feature}} -{{#children}} -

{{>partials/namespaceSubtitle}}

- {{#children}} -

-
{{{summary}}}
- {{/children}} -{{/children}} diff --git a/docs/template/styles/main.css b/docs/template/styles/main.css deleted file mode 100644 index 4ff3af1..0000000 --- a/docs/template/styles/main.css +++ /dev/null @@ -1,10 +0,0 @@ -h5.sinceTizen, h5.privlevel { - display: inline-block; -} -h5.sinceTizen:after, h5.privlevel:after { - content: ": "; -} -span.sinceTizen:after, span.privlevel:after { - white-space: pre; - content: "\A"; -} diff --git a/docs/templates/material/LICENSE b/docs/templates/material/LICENSE new file mode 100644 index 0000000..4576c42 --- /dev/null +++ b/docs/templates/material/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2019 Oscar Vásquez + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/docs/templates/material/partials/head.tmpl.partial b/docs/templates/material/partials/head.tmpl.partial new file mode 100644 index 0000000..c05e8c1 --- /dev/null +++ b/docs/templates/material/partials/head.tmpl.partial @@ -0,0 +1,21 @@ +{{!Copyright (c) Oscar Vasquez. All rights reserved. Licensed under the MIT license. See LICENSE file in the project root for full license information.}} + + + + + {{#title}}{{title}}{{/title}}{{^title}}{{>partials/title}}{{/title}} {{#_appTitle}}| {{_appTitle}} {{/_appTitle}} + + + + {{#_description}}{{/_description}} + + + + + + + + {{#_noindex}}{{/_noindex}} + {{#_enableSearch}}{{/_enableSearch}} + {{#_enableNewTab}}{{/_enableNewTab}} + \ No newline at end of file diff --git a/docs/templates/material/styles/main.css b/docs/templates/material/styles/main.css new file mode 100644 index 0000000..165a878 --- /dev/null +++ b/docs/templates/material/styles/main.css @@ -0,0 +1,299 @@ +/* COLOR VARIABLES*/ +:root { + --header-bg-color: #0d47a1; + --header-ft-color: #fff; + --highlight-light: #5e92f3; + --highlight-dark: #003c8f; + --accent-dim: #eee; + --font-color: #34393e; + --card-box-shadow: 0 1px 2px 0 rgba(61, 65, 68, 0.06), 0 1px 3px 1px rgba(61, 65, 68, 0.16); + --under-box-shadow: 0 4px 4px -2px #eee; + --search-box-shadow: 0px 0px 5px 0px rgba(255,255,255,1); +} + +body { + color: var(--font-color); + font-family: "Roboto", sans-serif; + line-height: 1.5; + font-size: 16px; + -ms-text-size-adjust: 100%; + -webkit-text-size-adjust: 100%; + word-wrap: break-word; +} + +/* HIGHLIGHT COLOR */ + +button, +a { + color: var(--highlight-dark); + cursor: pointer; +} + +button:hover, +button:focus, +a:hover, +a:focus { + color: var(--highlight-light); + text-decoration: none; +} + +.toc .nav > li.active > a { + color: var(--highlight-dark); +} + +.toc .nav > li.active > a:hover, +.toc .nav > li.active > a:focus { + color: var(--highlight-light); +} + +.pagination > .active > a { + background-color: var(--header-bg-color); + border-color: var(--header-bg-color); +} + +.pagination > .active > a, +.pagination > .active > a:focus, +.pagination > .active > a:hover, +.pagination > .active > span, +.pagination > .active > span:focus, +.pagination > .active > span:hover { + background-color: var(--highlight-light); + border-color: var(--highlight-light); +} + +/* HEADINGS */ + +h1 { + font-weight: 600; + font-size: 32px; +} + +h2 { + font-weight: 600; + font-size: 24px; + line-height: 1.8; +} + +h3 { + font-weight: 600; + font-size: 20px; + line-height: 1.8; +} + +h5 { + font-size: 14px; + padding: 10px 0px; +} + +article h1, +article h2, +article h3, +article h4 { + margin-top: 35px; + margin-bottom: 15px; +} + +article h4 { + padding-bottom: 8px; + border-bottom: 2px solid #ddd; +} + +/* NAVBAR */ + +.navbar-brand > img { + color: var(--header-ft-color); +} + +.navbar { + border: none; + /* Both navbars use box-shadow */ + -webkit-box-shadow: var(--card-box-shadow); + -moz-box-shadow: var(--card-box-shadow); + box-shadow: var(--card-box-shadow); +} + +.subnav { + border-top: 1px solid #ddd; + background-color: #fff; +} + +.navbar-inverse { + background-color: var(--header-bg-color); + z-index: 100; +} + +.navbar-inverse .navbar-nav > li > a, +.navbar-inverse .navbar-text { + color: var(--header-ft-color); + background-color: var(--header-bg-color); + border-bottom: 3px solid transparent; + padding-bottom: 12px; +} + +.navbar-inverse .navbar-nav > li > a:focus, +.navbar-inverse .navbar-nav > li > a:hover { + color: var(--header-ft-color); + background-color: var(--header-bg-color); + border-bottom: 3px solid white; +} + +.navbar-inverse .navbar-nav > .active > a, +.navbar-inverse .navbar-nav > .active > a:focus, +.navbar-inverse .navbar-nav > .active > a:hover { + color: var(--header-ft-color); + background-color: var(--header-bg-color); + border-bottom: 3px solid white; +} + +.navbar-form .form-control { + border: 0; + border-radius: 0; +} + +.navbar-form .form-control:hover { + box-shadow: var(--search-box-shadow); +} + +.toc-filter > input:hover { + box-shadow: var(--under-box-shadow); +} + +/* NAVBAR TOGGLED (small screens) */ + +.navbar-inverse .navbar-collapse, .navbar-inverse .navbar-form { + border: none; +} +.navbar-inverse .navbar-toggle { + box-shadow: var(--card-box-shadow); + border: none; +} + +.navbar-inverse .navbar-toggle:focus, +.navbar-inverse .navbar-toggle:hover { + background-color: var(--header-ft-color); +} + +/* SIDEBAR */ + +.toc .level1 > li { + font-weight: 400; +} + +.toc .nav > li > a { + color: var(--font-color); +} + +.sidefilter { + background-color: #fff; + border-left: none; + border-right: none; +} + +.sidefilter { + background-color: #fff; + border-left: none; + border-right: none; +} + +.toc-filter { + padding: 10px; + margin: 0; +} + +.toc-filter > input { + border: none; + border-bottom: 2px solid var(--accent-dim); +} + +.toc-filter > .filter-icon { + display: none; +} + +.sidetoc > .toc { + background-color: #fff; + overflow-x: hidden; +} + +.sidetoc { + background-color: #fff; + border: none; +} + +/* ALERTS */ + +.alert { + padding: 0px 0px 5px 0px; + color: inherit; + background-color: inherit; + border: none; + box-shadow: var(--card-box-shadow); +} + +.alert > p { + margin-bottom: 0; + padding: 5px 10px; +} + +.alert > ul { + margin-bottom: 0; + padding: 5px 40px; +} + +.alert > h5 { + padding: 10px 15px; + margin-top: 0; + text-transform: uppercase; + font-weight: bold; + border-radius: 4px 4px 0 0; +} + +.alert-info > h5 { + color: #1976d2; + border-bottom: 4px solid #1976d2; + background-color: #e3f2fd; +} + +.alert-warning > h5 { + color: #f57f17; + border-bottom: 4px solid #f57f17; + background-color: #fff3e0; +} + +.alert-danger > h5 { + color: #d32f2f; + border-bottom: 4px solid #d32f2f; + background-color: #ffebee; +} + +/* CODE HIGHLIGHT */ +pre { + padding: 9.5px; + margin: 0 0 10px; + font-size: 13px; + word-break: break-all; + word-wrap: break-word; + background-color: #fffaef; + border-radius: 4px; + border: none; + box-shadow: var(--card-box-shadow); +} + +/* STYLE FOR IMAGES */ + +.article .small-image { + margin-top: 15px; + box-shadow: var(--card-box-shadow); + max-width: 350px; +} + +.article .medium-image { + margin-top: 15px; + box-shadow: var(--card-box-shadow); + max-width: 550px; +} + +.article .large-image { + margin-top: 15px; + box-shadow: var(--card-box-shadow); + max-width: 700px; +} \ No newline at end of file diff --git a/docs/template/favicon.ico b/docs/templates/tizen/favicon.ico similarity index 100% rename from docs/template/favicon.ico rename to docs/templates/tizen/favicon.ico diff --git a/docs/templates/tizen/partials/affix.tmpl.partial b/docs/templates/tizen/partials/affix.tmpl.partial new file mode 100644 index 0000000..e08400f --- /dev/null +++ b/docs/templates/tizen/partials/affix.tmpl.partial @@ -0,0 +1,20 @@ +{{!Copyright (c) Microsoft. All rights reserved. Licensed under the MIT license. See LICENSE file in the project root for full license information.}} + + diff --git a/docs/template/partials/class.header.tmpl.partial b/docs/templates/tizen/partials/class.header.tmpl.partial similarity index 87% rename from docs/template/partials/class.header.tmpl.partial rename to docs/templates/tizen/partials/class.header.tmpl.partial index 73577a7..89965cd 100644 --- a/docs/template/partials/class.header.tmpl.partial +++ b/docs/templates/tizen/partials/class.header.tmpl.partial @@ -44,6 +44,18 @@ {{/inheritedMembers.0}}
{{__global.namespace}}: {{{namespace.specName.0.value}}}
{{__global.assembly}}: {{assemblies.0}}.dll
+{{#sincetizen}} +
{{__global.sincetizen}}: {{{sincetizen}}}
+{{/sincetizen}} +{{#privlevel}} +
{{__global.privlevel}}: {{{privlevel}}}
+{{/privlevel}} +{{#privilege}} +
{{__global.privilege}}: {{{privilege}}}
+{{/privilege}} +{{#feature}} +
{{__global.feature}}: {{{feature}}}
+{{/feature}}
{{__global.syntax}}
{{syntax.content.0.value}}
@@ -113,24 +125,6 @@
{{__global.remarks}}
{{{remarks}}}
{{/remarks}} - -{{#sincetizen}} -
{{__global.sincetizen}}
-{{{sincetizen}}} -{{/sincetizen}} -{{#privlevel}} -
{{__global.privlevel}}
-
{{{privlevel}}}
-{{/privlevel}} -{{#privilege}} -
{{__global.privilege}}
-
{{{privilege}}}
-{{/privilege}} -{{#feature}} -
{{__global.feature}}
-
{{{feature}}}
-{{/feature}} - {{#example.0}}
{{__global.examples}}
{{/example.0}} diff --git a/docs/template/partials/class.tmpl.partial b/docs/templates/tizen/partials/class.tmpl.partial similarity index 85% rename from docs/template/partials/class.tmpl.partial rename to docs/templates/tizen/partials/class.tmpl.partial index d2475c2..0e6f4ce 100644 --- a/docs/template/partials/class.tmpl.partial +++ b/docs/templates/tizen/partials/class.tmpl.partial @@ -5,11 +5,6 @@

{{>partials/classSubtitle}}

{{#children}} {{^_disableContribution}} -{{#docurl}} - - | - {{__global.improveThisDoc}} -{{/docurl}} {{#sourceurl}} {{__global.viewSource}} @@ -147,32 +142,6 @@
{{__global.remarks}}
{{{remarks}}}
{{/remarks}} - -{{#sinceTizen}} -
{{__global.sinceTizen}}
-{{{sinceTizen}}} -{{/sinceTizen}} -{{#pre}} -
{{__global.pre}}
-
{{{pre}}}
-{{/pre}} -{{#post}} -
{{__global.post}}
-
{{{post}}}
-{{/post}} -{{#privlevel}} -
{{__global.privlevel}}
-{{{privlevel}}} -{{/privlevel}} -{{#privilege}} -
{{__global.privilege}}
-
{{{privilege}}}
-{{/privilege}} -{{#feature}} -
{{__global.feature}}
-
{{{feature}}}
-{{/feature}} - {{#example.0}}
{{__global.examples}}
{{/example.0}} @@ -215,6 +184,26 @@ {{#seealso.0}}
{{/seealso.0}} + +{{#sincetizen}} +
{{__global.sincetizen}}: {{{sincetizen}}}
+{{/sincetizen}} +{{#privlevel}} +
{{__global.privlevel}}: {{{privlevel}}}
+{{/privlevel}} +{{#privilege}} +
{{__global.privilege}}: {{{privilege}}}
+{{/privilege}} +{{#feature}} +
{{__global.feature}}: {{{feature}}}
+{{/feature}} +{{#precondition}} +
{{__global.precondition}}: {{{precondition}}}
+{{/precondition}} +{{#postcondition}} +
{{__global.postcondition}}: {{{postcondition}}}
+{{/postcondition}} + {{/children}} {{/children}} {{#implements.0}} diff --git a/docs/template/partials/footer.tmpl.partial b/docs/templates/tizen/partials/footer.tmpl.partial similarity index 100% rename from docs/template/partials/footer.tmpl.partial rename to docs/templates/tizen/partials/footer.tmpl.partial diff --git a/docs/templates/tizen/partials/head.tmpl.partial b/docs/templates/tizen/partials/head.tmpl.partial new file mode 100644 index 0000000..c8d3669 --- /dev/null +++ b/docs/templates/tizen/partials/head.tmpl.partial @@ -0,0 +1,20 @@ + + + + {{#title}}{{title}}{{/title}}{{^title}}{{>partials/title}}{{/title}} {{#_appTitle}}| {{_appTitle}} {{/_appTitle}} + + + + {{#_description}}{{/_description}} + + + + + + + + + {{#_noindex}}{{/_noindex}} + {{#_enableSearch}}{{/_enableSearch}} + {{#_enableNewTab}}{{/_enableNewTab}} + \ No newline at end of file diff --git a/docs/template/partials/logo.tmpl.partial b/docs/templates/tizen/partials/logo.tmpl.partial similarity index 100% rename from docs/template/partials/logo.tmpl.partial rename to docs/templates/tizen/partials/logo.tmpl.partial diff --git a/docs/templates/tizen/plugins/Tizen.DocFX.Plugins.MetadataProvider.dll b/docs/templates/tizen/plugins/Tizen.DocFX.Plugins.MetadataProvider.dll new file mode 100644 index 0000000000000000000000000000000000000000..012f47dd53620a0063bd6c8d14e10a7c8ffc4a02 GIT binary patch literal 13312 zcmeHNe~=t?m4Dqm(=*evyV;q|ZhmYC6GC8;-He-GkYEzB+1(@y*<_Plk|4p&>`Z4f zFf%>ro>{U8xGQ=TaC)Mo1iV8d-W7P}h=p+K5rsP8u+&3y!pRAUmIcQNa#~uYawPY8 zue)bvli*>M{&AMQ+wc3{`@Zk{zVG|K@B4ncdj{U~QPPMgfcw-bqA#K3YlFbw4JJ|D zbnaK0=!=nWFZhzO_1g=E59FLg$+pJqbRm&R7mHRoF={64N->cuCVICIB??y7Of@zd z=Xxgwqs{NiEaCU=(sy^*IgShT`AklTM%ShX%aWtkpK3sAl-!asELui81*x8C7Xy0 zQne&Tq#I5vU{tqefEltdVFuYBo+e3}6$87WV|H9k#(_1G8VOkuv`dD>FW|R;zx0PM z&WNig+u(tAYbI-YUTX<-P%Ho+D^RV%4U5JIT|uHtr;RWS!ZBha48!ke^}VRC_7$<( zP}z1;X$iyvYd*kjBi1aiDs!N z*lGvHvXNM%GeLU9ng@o*x6T2cg#QieT!0H;Kq#32w)9a9Ds-|fSR0gU9gp~uU8hc+ zI%Ckz0#rpwx6VV^VsxyG8_9)?Mky9eVgVX6?N`Oc@y3&_=vaw0CKs_lLnzi@p>G4- z8_5fSEd6JwH%_*}(Y{aZpQ3FD^N5HsTAJYBCiX8VmG;n{o_?)lcx*ZenoRuj*b*|Sj!)qL5o`XP7J?9E0BL@Y#;5f51C+2A=?^D%B7 zu{uE8L4``OfR#XSSXeTK&u@46&@r9g;qqb2bpE9-A2T|gKjiW;ebe~`mycQW_!34i z!?>ioI#Kl#S&hpMdh+M4ug+7GOWEWl^VRpkO@SrCV> zOT0CC37xZ>po3GP-|3S76Xo2(c^U4E(M&_LE|D&w04YK@=*2}1WZ#Mj3E7VWhOKv_ zKDib^a?m;;L@$z#1=$$sY$n&+FmAonEa7~?SVJ2vf^U?Tt^jH9E*yerx0uL&*&&kSiJ^Yff(&D9M|d2XE)OZk<8fHJJggJ&coFH+^U_A0*NjVaC~cCKnn<@_M-xs;uwK;iN^n&m zDS2w&tn!c&Jf5cda>z<(Oggd}#X?IED*@UE1`_v#~Wp6ik&!c4nZk)7tsbr&X zECJ+@BtoFW8DKRXL-58nV9~gOjR3xE_aZP5vbKXSveqE5h7M%j9YA1M#M%i2`l?}C zX9P43p|?-X#bI#D+?1=$u`yJ=;_Vp=jKQ@Cc~MD_9pVU#z{rlJivUMnS;9 zLUS2{fPqEhG6VqwLva~`fB~Po3_-wvzg>ohc-bQ5oR7(wJ4*CIOQ1@;G?i_D+~j6$cs3OpUuX(%`^tkX{e4DT2Cguo@jKP33S zYY&ACdM#`kP1F-CLvl`(Ii0$RfWBQd;oOhVh^Es%>Qvh3<&YM+oF0NWnVH*dL^aLOK=EN~cudwa8qW3&}X$D>l!9PjtE(@H{#g zxibu%(#w#H`f1I?8Ra(pL5w<}zkw0mpuK@9`yW+{w9!#RL)#~V?~lgm5onuBn-#X| zF16igqsLG?mo64+RB z0p^tdnklU8FxFM6nUMk7Xru*N-|JG!#p>;# z(jK)*{kW!4)}z*`pVAQ73kcT~{W^3^3(=wTTLksEZxrNV2B zr!<2e5b8<#hv*4VFL=}q>T_C@X7a+IC+W-DOIicn=~08~D_SFc%A=l*{!DA4&w11p z(O+pZ=wXlQRR2e7rpJVuqT54SAVyt_SmzYYQ;a~IHeBFRcLw8u7JAg9er?PRw9-~y zrk>TaXrD`k=fF#|=zvFE2>r9@phso(6EvG9JnA~V8Po?n>c?m|hi>zzpP}6x`nX4> z!Y61hebS>Y4L5`OtVa!^uAM&bQKP79r-wc21@#2YqvIa+irNh7NtY5|pF>Xzb;s9ND8y<0_lK*{i%K8Wxa|wjpwf3m&w~gvg?=}DR{H&v*x4LaX%*JbS0f5GSdP9q zfCeoFY^G%b*9hzu*e`I0z$*nF1Z<^)3b(xja30;Q{3N`ZjwnZ>-LzP_Cb}8B%CX2W z&7^hFEZ}%FM-M2!MYf!Wwpj0UO#2LAfAoI(2CXqZk8FP|@+cmGS^hctx%w^C-W54P zUsee5^SE-q_AJ^?D$hfPwXGCA^U&&5S}U!-p&X9>n!c;t9(@b7lS-?yRwR#5bD&*$ zj`k=gsF&^wUIzS48dA2>2STPYA$lUp0kxpSl;;db83yOWz+X4+R$}T?+I`Ai;Y8He zjqfR0!565{Yp*JK^xmwNrT4`uTeVo(k6xCkjfm?tYCO7By<2%TxSDQ&J*Ki)`KG>2 zU86n~-J@QqsDY~iZ_%=9zj}|zKN`ITwcm-}0!|`&o4P}dMDI{PD82lp^m3(gTaYz> zC3J#fYB=zOdME7pG2p3imOe|Xw71mHi~JWw{!V%`*s9z~`=Tw{4Up97Hv%7}r?d_& zg?%>{NKp&ffbDb#;6l0wu!Ft}xPsmUd^hRA6!lOG;N`*}0_?`K#Qb14T}umtJ#-ay z2Ghbx3uj93DZ!5jenjy51b^Iv-1bL;|43>dQ(5Or0!d>$A#j7heF7&1ep=vT0$&nH z0g)HDkP5U+c~V)Zu2)OygX%0CbQRL@7vQHKx=-7UVt?c+z{`yhzz*TOPiOuw1n&up zjKH6&y92HU6{{|YJAzXO?>f8-%>q=B)1tuV0IJASjlkOhRmAKJ;O79UG#~3t!5IgS zU)X6{fG+?XpsVSx>0x>TJJB!j*5YdAM&%LZhe}wTtFBV-RsT-?5A`+m4K<)ewez&V zB(L`RYaRAXoUf|aDs8Wjyvl2mCNhBAk~0@y>vVb_$k z>(`8otQhH{wYzdouH5Z7W??ixv3}I!a`nn;^|o}ubV})r$@RkK`c>2Fv%?c5sb_Y7 zU$Ig!?eu8g+_#K|%IVCtD1C0(vO#T0I|qi$GV=?CN||N1=A3DCw{521?{3 zrtVV7EM|vu*PF#EZ?jph;%nDu{Kh?2K5t65PHMARH0@l5cA6#2F8AirV@1m;gTcys ztU|#omiw~=O}$nIjwqJXY;UcmJDa7oL%AY6dhN)_Mz{x01DkSY9_&FoH=fIzV`r(_ zWTwj%`z#gJHe1bcGk-RnW{*|O=Gcm})WZ0;ua*FDZQEGM!NNh?9CZ=2b1{*D*A7@& zDw<`doGxb5c2@kc8ILaMd^LnfWNT#q7HAnV?eSd3B;WBn&Hbir!aX#Q%h;AR@l#PG`zaY9L)qkD1w86P^U|Ejd+8cvi)R#-5=AX}dHufk`)g>?Q2wjaooDrq>&tAX_&*c8qk9G=A4q{2;Ymh`jDx{IBmk@(jInz^d?B= z032IoZM8D4!w3;Gnk%}3yuNDAljTO+_Y2pLG9h*!fa^rH7cMdkA9t-ZX)tX&CIWce zUG9F(?E7cY}=+k+1T545(o*B-S z>st(`ZA{Q6d=fFQv+QfnlxLsqf~5%GGb{Ux`z^a5D=eLVTPXz0{@hr_7P*=dcWlDk zY39?11aoTjzQuz!a!ICKtLQt#YrjVOf~+uIoTydotQ5<+0@fe+<=kj4pDWkZa$xRC z=PM>>ivc8I({{;WdjcF69~S{Hs)i3>va-k*)K|<{f_ODvPbtp_EV9)a+nu(HjJmHJ zXt3fOaKk)ZK2S?;1;nnThg8+_EYhc$mw0utD@sV3ri%|^wd~57*SSK~dYj9Mrqd-;T$rhKZJhTS!neP*$B7W^>TgV=+T$)1Hq?Z zc*(TO6CUljHgRfVuMxHax5gi+aHnla!g1%AhV5K|deTUZ`MivG7&)oP6WYT$1WA)5 znK0sJy1EEwXVsHl+_)J!cfIKIeT#hR?RRdp*tH$Ro5wna%ys=P;)+b;c%5N}Kd^>AL631ux$-$j})AqJp$4mOi5WJL~xA6dtU{(*Z068nDLAZTwN&TMEOB%eVyNb8L4$ zFE|H+pGaKARSLHC9jv5z8=-z@TP2_0Zub>Rpu_+_-4I>aO(p!9cypP>!8b?O3qAl? zrZjkIDJioP9Hw)S9K+L8xhk6=M>J%>*^fJe+QMn=6R5Gt0-vQVs({KsCIM(ct4a7K zchwcpd84L61%2F=re%-s8_Mq`d zzFf^&8J`8ndf4Y@^QQ%mCh#&p#juh6U7%4we94(r8_!7nh#E^63y+!Sh(fNN6!ER1 z#}M8HAfYH>EkQ~UNG!%=lb%qO zruZ_QIg?M!3PhC_11Vl*CmLBTS#}? z1o*KXU8t$hjMn&-N>gk6Y9*fb6{>MlZH?uWcp+W@au9ms=~yMcBPhb?AU63Nn$Kgs z+_HdvxR8EwZa>^yOnCv4O?cZNrYR~LA-#$4K?nz>ivXdUS)|9)P4UUsasRwEKKU!P zDK`0=ScON^Lah{t?|`isZd%~vTk$ESIi$m2-`;q$8fuMCs7>+aa6(0I%`HlV&77Q4 zo93a)E#c1=YJrR4t6QZWN+)lHHzvQJ0&&&f8id@u*+GNre5t8mL$ji=z}i zzu|GW;qk_h3RQQY-C_J2?ElHfnTmKl99CyHE0AF=Qip>3o=>W1JPcFWq{FW9cfj1R zuQ3t|#GB!v2hXD|0s*7x(H7#YHCQxV8M(}E%K~7>f3U(HH4s;d>EsU0o);oI-}|# zcZ2~0e0DwyMlhMoZXt}e5lkMnD~AAY0Ur^c(Xwp9@*bA6-f@tMs`)z5I1;m@4mOB_~1n0+j; zz9>p}A;tTe6EbPM>Ud?v`;3GV-{BGsBJV|?%$vj^uUf1~x46|UKI|5EyT#wQ#Sypo zTemnIg63vK0L;K-A8ne|rLY|mG4)QvJ1(UsScs<`Jc}w}g+dC;U4(3(+SWIWCsTRF(CIzwtQ%jR z!b}V|&8$8~@}q7(Jt2?PixoQmEN7H6o-Xi3TA`pk2jgolI$eg3x%hMWLg2$OTLO#R zYx3{$?(y`O5dN7HyK%;J9Lt`(`D|}8{D+(~�Y=-yz?b@JGEowQ5BQW_2dKqwl(+ zS;32ud}m^?GKvGt<>rJuA*?Inpx{|dH2WX7y+z8vpbE~%aG$>!_u^``yz9ho0_Z~A zkD%_6x;mEPZ`AeI&Y|9+b+an})!8`Ob7bg~iEj?v`y2MpdoJ0#8xQn*hx&R_n{(v@ zmC?OtnT5UnqmTcLx7QlIX0J@b-nzF*nBcRuK4T73rR*pTZRuXV>LT)u`jKZ84?O&_ zo!dULqT~7dk3W4=a7%3%=Q5tC(e;@BBS4pjcYJnlK0knyJQbXbg||rZSn9PnwFqiX zcTv5zKjZ&zJ-}blv3`gqrw_sX1qkxQ8GM%G$l9}y==-%#0l@KVG1^5#Gy>R1JAw7% zm$utL_XBQne|1a818&hK6i;Nd@`430ob$*ws%!;wsA4!c?QZNTZAw2bsqUc z*_Of+MIL{AB@q=0ZAE`$(i_i43G=|78N-uS88Qjn*Nbi2JwAJ$ZS(!flsjvG3>)1z zac4D)na{wgKUSP{;kP#mB8(%*@9XrLtIZpJcP?{$`V(aWtBND9Hrur}Jm-JD{^UHc U!Tnv|%GG~zBm47!-hl`H7fHsHy8r+H literal 0 HcmV?d00001 diff --git a/docs/templates/tizen/styles/tizen.css b/docs/templates/tizen/styles/tizen.css new file mode 100644 index 0000000..2df69e1 --- /dev/null +++ b/docs/templates/tizen/styles/tizen.css @@ -0,0 +1,38 @@ +:root { + --header-bg-color: #005; +} + +.tz_multiple_items > span { + margin-right: 10px; + background-color: #ccc; +} + +.decalaration, .parameters, .returns, .typeParameters, .fieldValue, .propertyValue, .eventType, .overrides, .exceptions { + color: #777; +} + +.container { + width: calc(100% - 10vw); +} + +.sidetoc { + width: 350px; +} + +.sidefilter { + width: 350px; +} + +.toc .level1 > li { + font-size: 14px; +} + +.article.grid-right { + margin-left: 360px; +} + +@media only screen and (max-width: 768px) { + .article.grid-right { + margin-left: 0; + } +} diff --git a/docs/template/token.json b/docs/templates/tizen/token.json similarity index 93% rename from docs/template/token.json rename to docs/templates/tizen/token.json index 3b44379..9079280 100644 --- a/docs/template/token.json +++ b/docs/templates/tizen/token.json @@ -43,9 +43,9 @@ "tip": "
Tip
", "important": "
Important
", "caution": "
Caution
", - "pre": "Precondition", - "post": "Postcondition", - "sinceTizen": "API Version", + "precondition": "Precondition", + "postcondition": "Postcondition", + "sincetizen": "API Level", "feature": "Feature", "privlevel": "Privilege Level", "privilege": "Privilege" diff --git a/docs/toc.yml b/docs/toc.yml index fa99406..bad8f9c 100644 --- a/docs/toc.yml +++ b/docs/toc.yml @@ -1,4 +1,4 @@ # YamlMime:TableOfContent -- name: API Documentation +- name: API Reference href: api/ homepage: api/index.md diff --git a/src/ElmSharp/ElmSharp/EcoreSynchronizationContext.cs b/src/ElmSharp/ElmSharp/EcoreSynchronizationContext.cs index 6185243..c0e966f 100644 --- a/src/ElmSharp/ElmSharp/EcoreSynchronizationContext.cs +++ b/src/ElmSharp/ElmSharp/EcoreSynchronizationContext.cs @@ -51,8 +51,8 @@ namespace ElmSharp /// /// Dispatches an asynchronous message to a Ecore main loop. /// - /// The SendOrPostCallback delegate to call. - /// The object passed to the delegate. + /// The delegate to call. + /// The object passed to the delegate. /// The Post method starts an asynchronous request to post a message. /// preview public override void Post(SendOrPostCallback d, object state) @@ -66,8 +66,8 @@ namespace ElmSharp /// /// Dispatches an synchronous message to a Ecore main loop. /// - /// The SendOrPostCallback delegate to call. - /// The object passed to the delegate. + /// The delegate to call. + /// The object passed to the delegate. /// /// The Send method starts a synchronous request to send a message. /// preview diff --git a/src/Tizen.NUI/src/public/VisualConstants.cs b/src/Tizen.NUI/src/public/VisualConstants.cs index 4cc4d00..f70b0b3 100755 --- a/src/Tizen.NUI/src/public/VisualConstants.cs +++ b/src/Tizen.NUI/src/public/VisualConstants.cs @@ -1195,6 +1195,7 @@ namespace Tizen.NUI internal static readonly int Cap = Thickness + 3; } + /// /// Enumeration for Circular alignment. /// The @p horizontalAlignment and @p verticalAlignment can be used to align the text within the text area. /// -- 2.7.4