diff --git a/.editorconfig b/.editorconfig new file mode 100644 index 0000000000..1864e6bd58 --- /dev/null +++ b/.editorconfig @@ -0,0 +1,12 @@ +root = true + +[*] +insert_final_newline = true + +[*.json] +indent_style = space +indent_size = 4 + +[*.schema] +indent_style = space +indent_size = 4 diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS new file mode 100644 index 0000000000..ad136dfa8a --- /dev/null +++ b/.github/CODEOWNERS @@ -0,0 +1,15 @@ +# Lines starting with '#' are comments. +# Each line is a file pattern followed by one or more owners. + +# More details are here: https://help.github.com/articles/about-codeowners/ + +# The '*' pattern is global owners. + +# Order is important. The last matching pattern has the most precedence. +# The folders are ordered as follows: + +# In each subsection folders are ordered first by depth, then alphabetically. +# This should make it easy to add new rules without breaking existing ones. + +# Global rule: +* @microsoft/botframework-sdk \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/bot-framework-bug.md b/.github/ISSUE_TEMPLATE/bot-framework-bug.md new file mode 100644 index 0000000000..55e6102432 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bot-framework-bug.md @@ -0,0 +1,61 @@ +--- +name: Bug +about: Report a new Bot Framework bug. +title: "" +labels: "needs-triage, bug" +assignees: "" +--- + +### [Github issues](https://github.com/microsoft/botframework-sdk) should be used for bugs and feature requests. Use [Stack Overflow](https://stackoverflow.com/questions/tagged/botframework) for general "how-to" questions. + +## Version +What package version of the SDK are you using. + +## Describe the bug +Give a clear and concise description of what the bug is. + +## To Reproduce +Steps to reproduce the behavior: +1. Go to '...' +2. Click on '....' +3. Scroll down to '....' +4. See error + +## Expected behavior +Give a clear and concise description of what you expected to happen. + +## Screenshots +If applicable, add screenshots to help explain your problem. + +## Additional context +Add any other context about the problem here. + +## Tracking Status + +**Dotnet SDK** [TODO]() +- [ ] PR +- [ ] Merged + +**Javascript SDK** [TODO]() +- [ ] PR +- [ ] Merged + +**Python SDK** [TODO]() +- [ ] PR +- [ ] Merged + +**Java SDK** [TODO]() +- [ ] PR +- [ ] Merged + +**Samples** [TODO]() +- [ ] PR +- [ ] Merged + +**Docs** [TODO]() +- [ ] PR +- [ ] Merged + +**Tools** [TODO]() +- [ ] PR +- [ ] Merged \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/bot-framework-feature-request.md b/.github/ISSUE_TEMPLATE/bot-framework-feature-request.md new file mode 100644 index 0000000000..fe3afa9f75 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bot-framework-feature-request.md @@ -0,0 +1,67 @@ +--- +name: Feature Request +about: Create a new Bot Framework feature request. +title: "" +labels: "needs-triage, feature-request" +assignees: "" +--- + +## This is not for asking questions or filing bugs + +To get help with an issue with your bot +* ["How To"](https://stackoverflow.com/help/how-to-ask) questions should be submitted on [Stack Overflow](https://stackoverflow.com/questions/tagged/botframework). + +To file an issue against a component please go to the components repo +* [Create Azure Bot Framework Service or Channel issue](https://github.com/Microsoft/botframework-services/issues/new/choose) +* [Create Bot Builder Tools issue](https://github.com/Microsoft/botbuilder-tools/issues/new/choose) +* [Create Bot Builder SDK V3 (.NET or Javascript) issue](https://github.com/Microsoft/botbuilder-V3/issues/new/choose) +* [Create Bot Builder SDK V4 .NET issue](https://github.com/Microsoft/botbuilder-dotnet/issues/new/choose) +* [Create Bot Builder SDK V4 Javascript issue](https://github.com/Microsoft/botbuilder-js/issues/new/choose) +* [Create Bot Builder SDK V4 Java issue](https://github.com/Microsoft/botbuilder-java/issues/new/choose) +* [Create Bot Builder SDK V4 Python issue](https://github.com/Microsoft/botbuilder-python/issues/new/choose) + +## Issue + +*Describe the issue you are addressing* + +## Proposed change + +*Describe the proposed solution* + +## Component Impact + +*Describe which components need to be updated* + +## Customer Impact + +*Describe the impact on customers* + +## Tracking Status + +**Dotnet SDK** [TODO]() +- [ ] PR +- [ ] Merged + +**Javascript SDK** [TODO]() +- [ ] PR +- [ ] Merged + +**Python SDK** [TODO]() +- [ ] PR +- [ ] Merged + +**Java SDK** [TODO]() +- [ ] PR +- [ ] Merged + +**Samples** [TODO]() +- [ ] PR +- [ ] Merged + +**Docs** [TODO]() +- [ ] PR +- [ ] Merged + +**Tools** [TODO]() +- [ ] PR +- [ ] Merged diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000000..42e51825a0 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,13 @@ +Fixes # + +## Proposed Changes + + + + - + - + - + + +## Testing + \ No newline at end of file diff --git a/.github/issue_template.md b/.github/issue_template.md index 37124032a5..4a6a69915a 100644 --- a/.github/issue_template.md +++ b/.github/issue_template.md @@ -1,23 +1,14 @@ - +## This is not for asking questions or filing bugs -## System Information (Required) -* SDK Language: -* SDK Version: -* Development Environment: +To get help with an issue with your bot +* ["How To"](https://stackoverflow.com/help/how-to-ask) questions should be submitted on [Stack Overflow](https://stackoverflow.com/questions/tagged/botframework) where there is a robust community to help you -## Issue Description - +To file an issue against a component please go to the components repo +* [Create Azure Bot Framework Service or Channel issue](https://github.com/Microsoft/botframework-services/issues/new/choose) +* [Create Bot Builder Tools issue](https://github.com/Microsoft/botbuilder-tools/issues/new/choose) +* [Create Bot Builder SDK V3 (.NET or Javascript) issue](https://github.com/Microsoft/botbuilder-V3/issues/new/choose) +* [Create Bot Builder SDK V4 .NET issue](https://github.com/Microsoft/botbuilder-dotnet/issues/new/choose) +* [Create Bot Builder SDK V4 Javascript issue](https://github.com/Microsoft/botbuilder-js/issues/new/choose) +* [Create Bot Builder SDK V4 Java issue](https://github.com/Microsoft/botbuilder-java/issues/new/choose) +* [Create Bot Builder SDK V4 Python issue](https://github.com/Microsoft/botbuilder-python/issues/new/choose) -## Code Example - - -## Steps to Reproduce the Issue -1. -2. -3. - -## Expected Behavior - - -## Actual Results - diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000000..59d3fefd21 --- /dev/null +++ b/.gitignore @@ -0,0 +1,32 @@ +## Ignore Visual Studio temporary files, build results, and +## files generated by popular Visual Studio add-ons. + +# User-specific files +*.suo +*.user +*.userosscache +*.sln.docstates + +# User-specific files (MonoDevelop/Xamarin Studio) +*.userprefs + +# Build results +[Dd]ebug/ +[Dd]ebugPublic/ +[Rr]elease/ +[Rr]eleases/ +x64/ +x86/ +bld/ +[Bb]in/ +[Oo]bj/ +ecf/ +rcf/ + +bones/ +.vs/ +.vscode/ +.config/ + +# Python virtual environments +**/*env/ diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 0000000000..f9ba8cf65f --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,9 @@ +# Microsoft Open Source Code of Conduct + +This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/). + +Resources: + +- [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/) +- [Microsoft Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) +- Contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with questions or concerns diff --git a/CSharp/.gitignore b/CSharp/.gitignore deleted file mode 100644 index fba4c25f31..0000000000 --- a/CSharp/.gitignore +++ /dev/null @@ -1,239 +0,0 @@ -## Ignore Visual Studio temporary files, build results, and -## files generated by popular Visual Studio add-ons. - -# User-specific files -*.suo -*.user -*.userosscache -*.sln.docstates - -# User-specific files (MonoDevelop/Xamarin Studio) -*.userprefs - -# Build results -[Dd]ebug/ -[Dd]ebugPublic/ -[Rr]elease/ -[Rr]eleases/ -x64/ -x86/ -build/ -bld/ -[Bb]in/ -[Oo]bj/ -ecf/ -rcf/ - -# Visual Studio 2015 cache/options directory -.vs/ - -# MSTest test Results -[Tt]est[Rr]esult*/ -[Bb]uild[Ll]og.* - -# NUNIT -*.VisualState.xml -TestResult.xml - -# Build Results of an ATL Project -[Dd]ebugPS/ -[Rr]eleasePS/ -dlldata.c - -# DNX -*.lock.json -artifacts/ - -*_i.c -*_p.c -*_i.h -*.ilk -*.meta -*.obj -*.pch -*.pdb -*.pgc -*.pgd -*.rsp -*.sbr -*.tlb -*.tli -*.tlh -*.tmp -*.tmp_proj -*.log -*.vspscc -*.vssscc -.builds -*.pidb -*.svclog -*.scc - -# Chutzpah Test files -_Chutzpah* - -# Visual C++ cache files -ipch/ -*.aps -*.ncb -*.opensdf -*.sdf -*.cachefile - -# Visual Studio profiler -*.psess -*.vsp -*.vspx - -# TFS 2012 Local Workspace -$tf/ - -# Guidance Automation Toolkit -*.gpState - -# ReSharper is a .NET coding add-in -_ReSharper*/ -*.[Rr]e[Ss]harper -*.DotSettings.user - -# JustCode is a .NET coding add-in -.JustCode - -# TeamCity is a build add-in -_TeamCity* - -# DotCover is a Code Coverage Tool -*.dotCover - -# NCrunch -_NCrunch_* -.*crunch*.local.xml - -# MightyMoose -*.mm.* -AutoTest.Net/ - -# Web workbench (sass) -.sass-cache/ - -# Installshield output folder -[Ee]xpress/ - -# DocProject is a documentation generator add-in -DocProject/buildhelp/ -DocProject/Help/*.HxT -DocProject/Help/*.HxC -DocProject/Help/*.hhc -DocProject/Help/*.hhk -DocProject/Help/*.hhp -DocProject/Help/Html2 -DocProject/Help/html - -# Click-Once directory -publish/ - -# Publish Web Output -*.[Pp]ublish.xml -## TODO: Comment the next line if you want to checkin your -## web deploy settings but do note that will include unencrypted -## passwords -#*.pubxml - -## ignore imporeted publish xml files -*intercom-botdirectory-scratch\ -\ FTP.pubxml -*intercom-botdirectory-scratch\ -\ Web\ Deploy.pubxml - -*.publishproj - -# NuGet Packages -*.nupkg -# The packages folder can be ignored because of Package Restore -**/packages/* -# except build/, which is used as an MSBuild target. -!**/packages/build/ -# Uncomment if necessary however generally it will be regenerated when needed -#!**/packages/repositories.config - -# Windows Azure Build Output -csx/ -*.build.csdef - -# Windows Store app package directory -AppPackages/ - -# Visual Studio cache files -# files ending in .cache can be ignored -*.[Cc]ache -# but keep track of directories ending in .cache -!*.[Cc]ache/ - -# Others -ClientBin/ -[Ss]tyle[Cc]op.* -~$* -*~ -*.dbmdl -*.dbproj.schemaview -*.pfx -*.publishsettings -node_modules/ -orleans.codegen.cs - -# RIA/Silverlight projects -Generated_Code/ - -# Backup & report files from converting an old project file -# to a newer Visual Studio version. Backup files are not needed, -# because we have git ;-) -_UpgradeReport_Files/ -Backup*/ -UpgradeLog*.XML -UpgradeLog*.htm - -# SQL Server files -*.mdf -*.ldf - -# Business Intelligence projects -*.rdl.data -*.bim.layout -*.bim_*.settings - -# Microsoft Fakes -FakesAssemblies/ - -# Node.js Tools for Visual Studio -.ntvs_analysis.dat - -# Visual Studio 6 build log -*.plg - -# Visual Studio 6 workspace options file -*.opt - -# LightSwitch generated files -GeneratedArtifacts/ -_Pvt_Extensions/ -ModelManifest.xml -/Microsoft.CodeDom.Providers.DotNetCompilerPlatform.dll -/Microsoft.CodeDom.Providers.DotNetCompilerPlatform.xml -/PublishScripts/Scripts/Deploy-AzureResourceGroup-5.ps1 -/PublishScripts - - - - - - - - - -# User-specific files -Documentation/Doxygen_warnings.txt - -# Build results -Documentation/docs/ - -# Azure publish profiles -*.pubxml -PublishProfiles/ diff --git a/CSharp/Documentation/Activities.cs b/CSharp/Documentation/Activities.cs deleted file mode 100644 index 73ced35f54..0000000000 --- a/CSharp/Documentation/Activities.cs +++ /dev/null @@ -1,430 +0,0 @@ -namespace Microsoft.Bot.Builder.Connector -{ - /** -\page activities Activities -An Activity is the object that is used to communicate between a user and a bot. When you send an Activity -there are a number of properties that you can use to control your message and how it is presented to the -user when they receive it. - -There are more than one type of Activity which are used to convey system operations or channel system operations -to the bot. They exist to give the %bot information about the state of the channel and the opportunity to respond -to them. - -Each Activity being routed through the %Connector has a Type field. Primarily, these will be of type message unless they are system -notifications for the %Bot. - -This table gives you basic overview of the Activity types: - -| **ActivityType** | **Interface** | **Description** | -| ------------------------------|------------------|----------------------------------------------------------------| -| **message** | IMessageActivity | a simple communication between a user <-> %bot | -| **conversationUpdate** | IConversationUpdateActivity| your %bot was added to a conversation or other conversation metadata changed | -| **contactRelationUpdate** | IContactRelationUpdateActivity| The %bot was added to or removed from a user's contact list | -| **typing** | ITypingActivity | The user or %bot on the other end of the conversation is typing | -| **ping** | n/a | an activity sent to test the security of a bot. | -| **deleteUserData** | n/a | A user has requested for the bot to delete any profile / user data | - - -\section message Message -The message activity is the core object exchanged between the user and the bot. It can represent a wide range of values from simple text input -and response all the way to complex multiple card carousel with buttons and actions - -\subsection textproperties Text and Locale Properties -For many developers the Text property is the only property you need to worry about. A person sent you some text, or -your %bot is sending some text back. There are 2 core properties for this, the Text and Locale property. - -| Property | Description | Example -| ------------|-------- ----------------------------------| ---------- -| **Text** | A text payload in markdown syntax which will be rendered as appropriate on each channel| Hello, how are you? -| **Locale** | The locale of the sender (if known) | en - -If all you do is exchange simple one-line text responses, you don't have to read any further. - -\subsection textformat TextFormat Property -Each message has an optional TextFormat property which represents how to interpret the Text property. - -| TextFormat Value | Description | Notes | -| ------------ |------------------------------------------| --------| -| **plain** | The text should be treated as raw text and no formatting applied at all | | -| **markdown** | The text should be treated as markdown formatting and rendered on the channel as appropriate | *default* | -| **xml** | The text is simple XML markup (subset of HTML) | *Skype Only* | - -\subsubsection markdown Markdown -The default text format is markdown which allows a nice balance of the bot being able to express what they want -and for the each channel to render as accurately as they can. - -The markdown that is supported: - -|Style | Markdown | Description | Example -|--------------------| --------------------------------------------------- |---------------------------------------- | ------ ------------------------------------------------------------- -| **Bold** | \*\*text\*\* | make the text bold | **text** -| **Italic** | \*text\* | make the text italic | *text* -| **Header1-5** | # H1 | Mark a line as a header | #H1 -| **Strikethrough** | \~\~text\~\~ | make the text strikethrough | ~~text~~ -| **Hr** | \-\-\- | insert a horizontal rule | | -| **Unordered list** | \* | Make an unordered list item | * text -| **Ordered list** | 1. | Make an ordered list item starting at 1 | 1. text -| **Pre** | \`text\` | Preformatted text(can be inline) | `text` -| **Block quote** | \> text | quote a section of text | > text -| **link** | \[bing](http://bing.com) | create a hyperlink with title | [bing](http://bing.com) -| **image link** | \![duck]\(http://aka.ms/Fo983c) | link to an image | ![duck](http://aka.ms/Fo983c) - -#### Markdown Paragraphs -As with most markdown systems, to represent a paragraph break you need to have a blank line. - -Markdown like this: - - This is - paragraph one - - This is - paragraph two - - -Will be rendered as - - This is paragraph one - This is paragraph two - -#### Markdown Fallback - -Not all channels can represent all markdown fields. As appropriate channels will fallback to a reasonable approximation, for -example, bold will be represented in text messaging as \*bold\* - -> Tables: If you are communicating with a channel which supports fixed width fonts or HTML you can use standard table -> markdown, but because many channels (such as SMS) do not have a known display width and/or have variable width fonts it -> is not possible to render a table properly on all channels. - -\subsubsection xml XML -Skype supports a subset of HTML tags it calls XML Markup (sometimes referred to as XMM). - -The tags that are supported are: - -|Style | Markdown |Description | Example -|--------------------| -----------------------------------------------------------------------|-----------------------------------------| ------ ------------------------------------------------------------- -| **Bold** | <b>text</b> | make the text bold | **text** -| **Italic** | <i>text</i> | make the text italic | *text* -| **Underline** | <u>text</u> | Mark a line as underline | text -| **Strikethrough** | <s>text</s> | make the text strikethrough | text -| **link** | <a href="http:bing.com">bing</a> | create a hyperlink with title | [bing](http://bing.com) - -\subsection attachmentsproperty Attachments Property -The Attachments property is an array of Attachment objects which allow you to send and receive images and other content, including rich cards. -The primary fields for an Attachment object are: - -| Name | Description | Example -| ------------|-------- ----------------------------------| ---------- -| **ContentType** | The contentType of the ContentUrl property| image/png -| **ContentUrl** | A link to content of type ContentType | http://somedomain.com/cat.jpg -| **Content** | An embedded object of type contentType | If contentType = "application/vnd.microsoft.hero" then Content would be a JSON object for the HeroCard - - -Some channels allow you to represent a card responses made up of a title, link, description and images. There are multiple card formats, including HeroCard, -ThumbnailCard, Receipt Card and Sign in. Additionally your card can optionally be displayed as a list or a carousel using the **AttachmentLayout** -property of the Activity. See [Attachments, Cards and Actions](/en-us/csharp/builder/sdkreference/attachments.html) for more info about Attachments. - -\subsection attachmentlayoutproperty AttachmentLayout property -You can send multiple rich card attachments in a single message. On most channels they will be sent -as a list of rich cards, but some channels (like Skype and Facebook) can render them as a carousel of rich cards. - -As the developer you have the ability to control whether the list is rendered as a carousel or a vertical list using the **AttachmentLayout** property. -| AttachmentLayout Value | Description | Notes | -| ------------ |------------------------------------------| --------| -| **list** | Multiple attachments should be shown as a list| *default* | -| **carousel** | multiple attachments should be shown as a carousel if possible, else fall back to a list| | - - -~~~{.cs} - -Activity replyToConversation = message.CreateReply("Should go to conversation, with a carousel"); -replyToConversation.Recipient = message.From; -replyToConversation.Type = "message"; -replyToConversation.AttachmentLayout = AttachmentLayouts.Carousel; -replyToConversation.Attachments = new List(); - -Dictionary cardContentList = new Dictionary(); -cardContentList.Add("PigLatin", "https://"); -cardContentList.Add("Pork Shoulder", "https://"); -cardContentList.Add("Bacon", "https://"); - -foreach(KeyValuePair cardContent in cardContentList) -{ - List cardImages = new List(); - cardImages.Add(new CardImage(url:cardContent.Value )); - - List cardButtons = new List(); - - CardAction plButton = new CardAction() - { - Value = $"https://en.wikipedia.org/wiki/{cardContent.Key}", - Type = "openUrl", - Title = "WikiPedia Page" - }; - cardButtons.Add(plButton); - - HeroCard plCard = new HeroCard() - { - Title = $"I'm a hero card about {cardContent.Key}", - Subtitle = $"{cardContent.Key} Wikipedia Page", - Images = cardImages, - Buttons = cardButtons - }; - - Attachment plAttachment = plCard.ToAttachment(); - replyToConversation.Attachments.Add(plAttachment); -} - -replyToConversation.AttachmentLayout = AttachmentLayoutTypes.Carousel; - -var reply = await connector.Conversations.SendToConversationAsync(replyToConversation); - -~~~ - -~~~{.json} - ... -"attachmentLayout":"carousel", -"attachments": [ - { - "contentType": "application/vnd.microsoft.card.hero", - "content": { - "title": "I'm a hero card about Pig Latin", - "subtitle": "PigLatin Wikipedia Page", - "images": [ - { - "url": "https://" - } - ], - "buttons": [ - { - "type": "openUrl", - "title": "WikiPedia Page", - "value": "https://en.wikipedia.org/wiki/{cardContent.Key}" - } - ] - } - }, - { - "contentType": "application/vnd.microsoft.card.hero", - "content": { - "title": "I'm a hero card about pork shoulder", - "subtitle": "Pork Shoulder Wikipedia Page", - "images": [ - { - "url": "https://" - } - ], - "buttons": [ - { - "type": "openUrl", - "title": "WikiPedia Page", - "value": "https://en.wikipedia.org/wiki/{cardContent.Key}" - } - ] - } - }, - { - "contentType": "application/vnd.microsoft.card.hero", - "content": { - "title": "I'm a hero card about Bacon", - "subtitle": "Bacon Wikipedia Page", - "images": [ - { - "url": "https://" - } - ], - "buttons": [ - { - "type": "openUrl", - "title": "WikiPedia Page", - "value": "https://en.wikipedia.org/wiki/{cardContent.Key}" - } - ] - } - } -], -... -} - -~~~ - - -\subsection entities Entities Property -The Entities property is an array of open ended [schema.org](http://schema.org) objects which allows the exchange of -common contextual metadata between the channel and bot. - -\subsubsection mentions Mention Entities -Many communication clients have mechanisms to "mention" someone. Knowing that someone is -mentioned can be an important piece of information for a %bot that the channel knows and needs to be able -to pass to you. - -Frequently a %bot needs to know that __they__ were mentioned, but with some channels -they don't always know what their name is on that channel. (again see Slack and Group me where names -are assigned per conversation) - -To accommodate these needs the Entities property includes Mention objects, accessible through the GetMentions() method. - -> The Mention object -| **Property** | **Description** | -|--------------|-------------------------------------| -| **type** | type of the entity ("mention") | -| **mentioned**| ChannelAccount of the person or user who was mentioned | -| **text** | the text in the Activity.Text property which represents the mention. (this can be empty or null) | - -Example: -The user on slack says: - -> \@ColorBot pick me a new color - -~~~ -{ - ... - "entities": [{ - "type":"mention", - "mentioned": { - "id": "UV341235", "name":"Color Bot" - }, - "text": "@ColorBot" - }] - ... -} -~~~ - -This allows the %bot to know that they were mentioned and to ignore the @ColorBot part of the input when -trying to determine the user intent. - -> NOTE: Mentions go both ways. A %bot may want to mention a user in a reply to a conversation. If they fill out -> the Mentions object with the mention information then it allows the Channel to map it to the mentioning semantics of the channel. - -\subsubsection places Place Entities -Place represents information from . We currently send address and geographical information from the channels. - -The %Connector client library defines two typed classes to make it easier to work with: - -> The Place Object -| **Property** | **Description** | -|-------------- |-------------------------------------| -| **Type** | 'Place' | -| **Address** | string description or PostalAddress (future) | -| **Geo** | GeoCoordinates | -| **HasMap** | URL to a map or complex "Map" object (future) | -| **Name** | Name of the place | - -> GeoCoordinates Object -| **Property** | **Description** | -|-------------- |-------------------------------------| -| **Type** | 'GeoCoordinates' | -| **Name** | Name of the place | -| **Longitude** | Longitude of the location [WGS 84](https://en.wikipedia.org/wiki/World**Geodetic**System)| -| **Latitude** | Latitude of the location [WGS 84](https://en.wikipedia.org/wiki/World**Geodetic**System)| -| **Elevation** | Elevation of the location [WGS 84](https://en.wikipedia.org/wiki/World_Geodetic_System)| - -Example of adding Geo place data to Entities using strong types: -~~~{.cs} - var entity = new Entity(); - entity.SetAs(new Place() - { - Geo = new GeoCoordinates() - { - Latitude = 32.4141, - Longitude = 43.1123123, - } - }); - entities.Add(entity); -~~~ - -~~~{.json} -"entities":[ - { - "type": "Place", - "geo": { - "latitude": 32.4141, - "longitude": 43.1123123, - "type": "GeoCoordinates" - } - } -] -~~~ - -When consuming entities you can use dynamic keyword like this: -~~~{.cs} - if (entity.Type == "Place") - { - dynamic place = entity.Properties; - if (place.geo.latitude > 34) - // do something - } -~~~ - -Or you can use the strongly typed classes like this: -~~~{.cs} - if (entity.Type == "Place") - { - Place place = entity.GetAs(); - GeoCoordinates geo = place.Geo.ToObject(); - if (geo.Latitude > 34) - // do something - } -~~~ - -\subsection channeldataproperty ChannelData Property -With the combination of the Attachments section below the common message schema gives you a rich palette to describe your response in way -that allows your message to "just work" across a variety of channels. - -If you want to be able to take advantage of special features or concepts for a channel we provide a way for you to send native -metadata to that channel giving you much deeper control over how your %bot interacts on a channel. The way you do this is to pass -extra properties via the *ChannelData* property. - -Go to [ChannelData in Messages](/en-us/csharp/builder/sdkreference/channels.html) for more detailed description of what each channel enables via the ChannelData Property. - - -\section conversationUpdate Conversation Update -> the membership or metadata of a conversation involving the %bot changed - -Your %bot often needs to know when the state of the conversation it's in has changed. This may represent the %bot being added to -the conversation, or a person added or remove from the chat. When these changes happen, your %bot will receive a conversationUpdate -Activity. - -Conversation Update properties -| **Properties** | **Description** | -| ------------------ |------------------------------------------| -| **MembersAdded** | array of ChannelAccount[] for the added accounts | -| **MembersRemoved** | array of ChannelAccount[] for the removed accounts | - -In this event, the membersAdded and membersRemoved lists will contain the changes to the conversation since the last event. One of -the members may be the Bot; which can be tested for by comparing the membersAdded\[n].id field with the recipient.id field. - -conversationUpdate is a great opportunity for the %Bot to send welcome messages to users. - -\section contactrelationupdate Contact Relation Update -> The %bot was added to or removed from a user's contact list - -For some channels your %bot can be a member of the user's contact list on that chat service (Skype for example). In the -event the channel supports this action, it can notify the %Bot that this has occurred. When this event is delivered, -the **Action** property will indicate whether the operation was an **add** or a **remove**. - -| **Action values** | **Description** | -| ----------------- |------------------------------------------| -| **add** | if the user in the From property added the bot to their contacts | -| **remove** | if the user in the From property removed the bot from their contacts | - -\section typing Typing -> A message that indicates that the user or %Bot is typing - -Typing is an indicator of activity on the other side of the conversation. Generally it's used by Bots to -cover "dead air" while the %bot is fulfilling a request of some sort. The %Bot may also receive Typing -messages from the user, for whatever purposes it might find useful. - -\section ping Ping -> A message that is used to test that a %Bot has implemented security correctly -The bot receiving this should not send any response except for the HttpStatusCode response of OK, Forbidden or Unauthorized - -\section deleteuserdata Delete User Data -> A compliance request from the the user to delete any profile / user data - -Bots have access to users conversation data. Many countries have legal requirements that a user -has the ability to request their data to be dropped. If you receive a message of this type -you should remove any personally identifiable information (PII) for the user. - - - **/ -} diff --git a/CSharp/Documentation/Attachments.cs b/CSharp/Documentation/Attachments.cs deleted file mode 100644 index 3b3bcf2f9e..0000000000 --- a/CSharp/Documentation/Attachments.cs +++ /dev/null @@ -1,443 +0,0 @@ -namespace Microsoft.Bot.Builder.Connector -{ - /** -\page attachments Attachments, Cards and Actions - -Many messaging channels provide the ability to attach richer objects. In the %Bot %Connector we map -our attachment data structure to media attachments and rich cards on each channel. - -\section imagefileattachments Media Attachments -To pass a simple media attachment (image/audio/video/file) to an activity you add a simple attachment data structure with a link to the -content, setting the ContentType, ContentUrl and Name properties. - -| **Property** | **Description** | **Example** | -|-----|------| ---- | -| **ContentType** | mimetype/contenttype of the URL | image/jpg | -| **ContentUrl** | a link to the actual file | http://foo.com/1312312 | -| **Name** | the name of the file | foo.jpg | - -If the content type is a image or media content type then it will be passed to the channel in a way that -allows the image to be displayed. If it is a file then it will simply come through as a link. - -~~~ - -replyMessage.Attachments.Add(new Attachment() -{ - ContentUrl = "https://upload.wikimedia.org/wikipedia/en/a/a6/Bender_Rodriguez.png", - ContentType = "image/png", - Name = "Bender_Rodriguez.png" -}); -~~~ - -~~~{.json} - -{ - "attachments": [ - { - "contentType": "image/png", - "contentUrl": "https://upload.wikimedia.org/wikipedia/en/a/a6/Bender_Rodriguez.png" - "name":"Bender_Rodriguez.png" - } - ] -} - -~~~ - -\section richcards Rich card attachments -We also have the ability to render rich cards as attachments. There are several types of cards supported: - -| **Card Type** | **Description** | **Supported Modes** | -|-----------|-------------|-----------------| -| **Hero Card** | A card with one big image | Single or Carousel | -| **Thumbnail Card** | A card with a single small image | Single or Carousel | -| **Receipt Card** | A card that lets the user deliver an invoice or receipt | Single | -| **Sign-In Card** | A card that lets the %bot initiate a sign-in procedure | Single | - -\subsection herocard Hero Card -The Hero card is a multipurpose card; it primarily hosts a single large image, a button, and a "tap action", along with text content to display on the card. - -| **Property** | **Description** | -|-----|------| -| **Title** | Title of card| -| **Subtitle** | Link for the title | -| **Text** | Text of the card | -| **Images[]** | For a hero card, a single image is supported | -| **Buttons[]** | Hero cards support one or more buttons | -| **Tap** | An action to take when tapping on the card | - -Sample using the C# SDK: - -~~~{.cs} - -Activity replyToConversation = message.CreateReply("Should go to conversation, with a hero card"); -replyToConversation.Recipient = message.From; -replyToConversation.Type = "message"; -replyToConversation.Attachments = new List(); - -List cardImages = new List(); -cardImages.Add(new CardImage(url: "https://")); -cardImages.Add(new CardImage(url: "https://")); - -List cardButtons = new List(); - -CardAction plButton = new CardAction() -{ -Value = "https://en.wikipedia.org/wiki/Pig_Latin", -Type = "openUrl", -Title = "WikiPedia Page" -}; -cardButtons.Add(plButton); - -HeroCard plCard = new HeroCard() -{ - Title = "I'm a hero card", - Subtitle = "Pig Latin Wikipedia Page", - Images = cardImages, - Buttons = cardButtons -}; - -Attachment plAttachment = plCard.ToAttachment(); -replyToConversation.Attachments.Add(plAttachment); - -var reply = await connector.Conversations.SendToConversationAsync(replyToConversation); - -~~~ - -~~~{.json} - - { - "attachments": [ - { - "contentType": "application/vnd.microsoft.card.hero", - "content": { - "title": "I'm a hero card", - "subtitle": "Pig Latin Wikipedia Page", - "images": [ - { - "url": "https://" - }, - { - "url": "https://" - } - ], - "buttons": [ - { - "type": "openUrl", - "title": "WikiPedia Page", - "value": "https://en.wikipedia.org/wiki/Pig_Latin" - } - ] - } - } - ], -} - -~~~ - -\subsection thumbnailcard Thumbnail Card -The Thumbnail card is a multipurpose card; it primarily hosts a single small image, a button, and a "tap action", along with text content to display on the card. - -| **Property** | **Description** | -|-----|------| -| **Title** | Title of card| -| **Subtitle** | Link for the title | -| **Text** | Text of the card | -| **Images[]** | For a hero card, a single image is supported | -| **Buttons[]** | Hero cards support one or more buttons | -| **Tap** | An action to take when tapping on the card | - -Sample using the C# SDK: - -~~~{.cs} - -Activity replyToConversation = message.CreateReply("Should go to conversation, with a thumbnail card"); -replyToConversation.Recipient = message.From; -replyToConversation.Type = "message"; -replyToConversation.Attachments = new List(); - -List cardImages = new List(); -cardImages.Add(new CardImage(url: "https://")); - -List cardButtons = new List(); - -CardAction plButton = new CardAction() -{ -Value = "https://en.wikipedia.org/wiki/Pig_Latin", -Type = "openUrl", -Title = "WikiPedia Page" -}; -cardButtons.Add(plButton); - -ThumbnailCard plCard = new ThumbnailCard() -{ - Title = "I'm a thumbnail card", - Subtitle = "Pig Latin Wikipedia Page", - Images = cardImages, - Buttons = cardButtons -}; - -Attachment plAttachment = plCard.ToAttachment(); -replyToConversation.Attachments.Add(plAttachment); - -var reply = await connector.Conversations.SendToConversationAsync(replyToConversation); - -~~~ - -~~~{.json} - - { - "attachments": [ - { - "contentType": "application/vnd.microsoft.card.thumbnail", - "content": { - "title": "I'm a thumbnail card", - "subtitle": "Pig Latin Wikipedia Page", - "images": [ - { - "url": "https://" - } - ], - "buttons": [ - { - "type": "openUrl", - "title": "WikiPedia Page", - "value": "https://en.wikipedia.org/wiki/Pig_Latin" - } - ] - } - } - ], -} - -~~~ - -\subsection receiptcard Receipt Card -The receipt card allows the %Bot to present a receipt to the user. - -| **Property** | **Description** | -|-----|------| -| **Title** | **Title of card** | -| **Facts[]** | Key Value pair list of information to display on the receipt | -| **Items[]** | The list of ReceiptItem objects on this receipt | -| **Tap** | An action to take when tapping on the card | -| **Tax** | Tax on this receipt | -| **VAT** | Any additional VAT on this receipt | -| **Total** | The Sum Total of the Receipt | -| **Buttons[]** | Hero cards support one or more buttons | - - -Sample using the C# SDK: - -~~~{.cs} - -Activity replyToConversation = message.CreateReply("Receipt card"); -replyToConversation.Recipient = message.From; -replyToConversation.Type = "message"; -replyToConversation.Attachments = new List(); - -List cardImages = new List(); -cardImages.Add(new CardImage(url: "https://")); - -List cardButtons = new List(); - -CardAction plButton = new CardAction() -{ -Value = "https://en.wikipedia.org/wiki/Pig_Latin", -Type = "openUrl", -Title = "WikiPedia Page" -}; -cardButtons.Add(plButton); - -ReceiptItem lineItem1 = new ReceiptItem() -{ - Title = "Pork Shoulder", - Subtitle = "8 lbs", - Text = null, - Image = new CardImage(url: "https://"), - Price = "16.25", - Quantity = "1", - Tap = null -}; - -ReceiptItem lineItem2 = new ReceiptItem() -{ -Title = "Bacon", -Subtitle = "5 lbs", -Text = null, -Image = new CardImage(url: "https://"), -Price = "34.50", -Quantity = "2", -Tap = null -}; - -List receiptList = new List(); -receiptList.Add(lineItem1); -receiptList.Add(lineItem2); - -ReceiptCard plCard = new ReceiptCard() -{ - Title = "I'm a receipt card, isn't this bacon expensive?", - Buttons = cardButtons, - Items = receiptList, - Total = "275.25", - Tax = "27.52" -}; - -Attachment plAttachment = plCard.ToAttachment(); -replyToConversation.Attachments.Add(plAttachment); - -var reply = await connector.Conversations.SendToConversationAsync(replyToConversation); - -~~~ - -~~~{.json} - - { - "attachments": [ - { - "contentType": "application/vnd.microsoft.card.receipt", - "content": { - "title": "I'm a receipt card, isn't this bacon expensive?", - "items": [ - { - "title": "Pork Shoulder", - "subtitle": "8 lbs", - "image": { - "url": "https://" - }, - "price": "16.25", - "quantity": "1" - }, - { - "title": "Bacon", - "subtitle": "5 lbs", - "image": { - "url": "https://" - }, - "price": "34.50", - "quantity": "2" - } - ], - "total": "275.25", - "tax": "27.52", - "buttons": [ - { - "type": "openUrl", - "title": "WikiPedia Page", - "value": "https://en.wikipedia.org/wiki/Pig_Latin" - } - ] - } - } - ], -} - -~~~ - -\subsection signincard Sign-In Card - -The Sign-In card is a card representing a request to sign in the user; - -| **Property** | **Type** | **Description** -|-----------|---------- | ----- -| **Text** | string | Text of the card -| **Buttons[]** | Action[] | Action to use to perform for Sign-In - -~~~{.cs} - -Activity replyToConversation = message.CreateReply(translateToPigLatin("Should go to conversation, sign-in card")); -replyToConversation.Recipient = message.From; -replyToConversation.Type = "message"; -replyToConversation.Attachments = new List(); - -List cardButtons = new List(); - -CardAction plButton = new CardAction() -{ - Value = "https://", - Type = "signin", - Title = "Connect" -}; -cardButtons.Add(plButton); - -SigninCard plCard = new SigninCard(title: "You need to authorize me", button: plButton); - -Attachment plAttachment = plCard.ToAttachment(); -replyToConversation.Attachments.Add(plAttachment); - -var reply = await connector.Conversations.SendToConversationAsync(replyToConversation); - -~~~ - - -Generates JSON - -~~~{.json} - - { - "type": "message/card.signin", - "attachments": [ - { - "contentType": "application/vnd.microsoft.card.signin", - "content": - { - "text": "You need to authorize me", - "buttons": [ - { - "type": "signin", - "title": "Connect", - "value": "https://" - } - ] - } - } - ] -} - -~~~ - -\section cardaction Button and Card Actions - -The CardAction type is used to represent the information needed to process a button or a tap on a section of a rich card. - -| **Property** | **Type** | **Description** -|-----------|---------- | ----- -| **Type** | string | action types as specified in table below -| **Title** | string | Title for button -| **Image** | string | Image URL for button -| **Value** | string | value to perform action - -| **Action types** | **Content of value property** -|---------------|------------------------------ -| **openUrl** | URL to be opened in the built-in browser. -| **imBack** | Text of message which client will sent back to bot as ordinary chat message. All other participants will see that was posted to the bot and who posted this. -| **postBack** | Text of message which client will post to bot. Client applications will not display this message. -| **call** | Destination for a call in following format: "tel:123123123123" -| **playAudio** | playback audio container referenced by URL -| **playVideo** | playback video container referenced by URL -| **showImage** | show image referenced by URL -| **downloadFile** | download file referenced by URL -| **signin** | OAuth flow URL -__Note__: Only the following action types are supported by Skype: `openUrl`, `imBack`, `call`, `showImage`, `signin` - -~~~{.cs} -CardAction button = new CardAction() -{ - Type = "imBack", - Title = "Hello" - Value = "I sez hello!" -}; -~~~ - - -Generates JSON -~~~{.json} -{ - "type": "imBack", - "title": "Hello", - "value": "I sez hello!" -} -~~~ - - **/ -} diff --git a/CSharp/Documentation/Channels.cs b/CSharp/Documentation/Channels.cs deleted file mode 100644 index 9e17a0693f..0000000000 --- a/CSharp/Documentation/Channels.cs +++ /dev/null @@ -1,449 +0,0 @@ -namespace Microsoft.Bot.Builder.Connector -{ - /** -\page channels Channels Custom Channel Capabilities -If you want to be able to take advantage of special features or concepts for a channel we provide a way for you to send native -metadata to that channel giving you much deeper control over how your %bot interacts on a channel. The way you do this is to pass -extra properties via the *ChannelData* property. - ->NOTE: You do not need to use this feature unless you feel the need to access functionality not provided by the normal Activity. - -\section customemailmessages Custom Email Messages -The Email channel optionally supports the ability to send custom properties to take advantage of what you can do with email. - - -When you receive a message via email the channelData will have metadata from the source message. - - -When you reply to a message via the email channel you can specify the following properties: - -| **Property** | **Description** -|---------| ----- -| *HtmlBody* | The HTML to use for the body of the message -| *Subject* | The subject to use for the message -| *Importance* | The importance flag to use for the message (Low/Normal/High) - - -Example Message: - -~~~{.json} - - { - "type": "message", - "locale": "en-Us", - "channelID":"email", - "from": { "id":"mybot@gmail.com", "name":"My bot"}, - "recipient": { "id":"joe@gmail.com", "name":"Joe Doe"}, - "conversation": { "id":"123123123123", "topic":"awesome chat" }, - "channelData": - { - "htmlBody" : "This is more than awesome", - "subject":"Super awesome message subject", - "importance":"high" - } - } - -~~~ - - -\section customslackmessages Custom Slack Messages - Slack supports the ability to create full fidelity slack messages. The slack -channel allows bots to pass custom Slack messages via the ChannelData field. Custom messages passed via ChannelData will -be posted directly to Slack via their chat.postMessage api. - -> See [Slack Messages](https://api.slack.com/docs/messages) for a description of the Slack message format -> -> See [Slack Attachments](https://api.slack.com/docs/attachments) for a description of Slack attachments - -Example outgoing message with custom Slack message in ChannelData: - -~~~{.json} -{ - "type": "message", - "locale": "en-Us", - "channelId":"slack", - "conversation": { "id":"123123123123", "topic":"awesome chat" }, - "from": { "id":"12345", "name":"My Bot"}, - "recipient": { "id":"67890", "name":"Joe Doe"}, - "channelData": - { - "text": "Now back in stock! :tada:", - "attachments": [ - { - "title": "The Further Adventures of Slackbot", - "author_name": "Stanford S. Strickland", - "author_icon": "https://api.slack.com/img/api/homepage_custom_integrations-2x.png", - "image_url": "http://i.imgur.com/OJkaVOI.jpg?1" - }, - { - "fields": [ - { - "title": "Volume", - "value": "1", - "short": true - }, - { - "title": "Issue", - "value": "3", - "short": true - } - ] - }, - { - "title": "Synopsis", - "text": "After @episod pushed exciting changes to a devious new branch back in Issue 1, Slackbot notifies @don about an unexpected deploy..." - }, - { - "fallback": "Would you recommend it to customers?", - "title": "Would you recommend it to customers?", - "callback_id": "comic_1234_xyz", - "color": "#3AA3E3", - "attachment_type": "default", - "actions": [ - { - "name": "recommend", - "text": "Recommend", - "type": "button", - "value": "recommend" - }, - { - "name": "no", - "text": "No", - "type": "button", - "value": "bad" - } - ] - } - ] - }, - ... -} -~~~ - -When a user clicks a button in Slack, a message will be sent to your bot with _ChannelData_ containing a _Payload_ corresponding to the message action. -The payload contains the original message as well as information about which button was clicked and who clicked it. Your bot can then take whatever -action is necessary in response to the button click, including modifying the original message and posting to directly back to Slack via the _response_url_ -that's included in the payload. - -> See [Slack Buttons](https://api.slack.com/docs/message-buttons) for a description of interactive Slack messages -> -> To support Slack buttons, you must follow the instructions to enable Interactive Messages when [configuring](https://dev.botframework.com/bots) your bot on the Slack channel. - -Example incoming button click message: - -~~~{.json} -{ - "type": "message", - "serviceUrl": "https://slack.botframework.com", - "channelId": "slack", - "from": {...}, - "conversation": {...}, - "recipient": {...}, - "text": "recommend", - "entities": [...], - "channelData": { - "Payload": { - "actions": [ - { - "name": "recommend", - "value": "recommend" - } - ], - "callback_id": "comic_1234_xyz", - "team": {...}, - "channel": {...}, - "user": {...}, - "attachment_id": "3", - "token": "...", - "original_message": { - "text": "New comic book alert!\n", - "username": "TestBot-V3 (Prod)", - "bot_id": "B1Q3CDE1M", - "attachments": [ - { - "fallback": "332x508px image", - "image_url": "http://i.imgur.com/OJkaVOI.jpg?1", - "image_width": 332, - "image_height": 508, - "image_bytes": 60672, - "author_name": "Stanford S. Strickland", - "title": "The Further Adventures of Slackbot", - "id": 1, - "author_icon": "https://api.slack.com/img/api/homepage_custom_integrations-2x.png", - "fields": [ - { - "title": "Volume", - "value": "1", - "short": true - }, - { - "title": "Issue", - "value": "3", - "short": true - } - ] - }, - { - "text": "After @episod pushed exciting changes to a devious new branch back in Issue 1, Slackbot notifies @don about an unexpected deploy...", - "title": "Synopsis", - "id": 2, - "fallback": "NO FALLBACK DEFINED" - }, - { - "callback_id": "comic_1234_xyz", - "fallback": "Would you recommend it to customers?", - "title": "Would you recommend it to customers?", - "id": 3, - "color": "3AA3E3", - "actions": [ - { - "id": "1", - "name": "recommend", - "text": "Recommend", - "type": "button", - "value": "recommend" - }, - { - "id": "2", - "name": "no", - "text": "No", - "type": "button", - "value": "bad" - } - ] - } - ], - "type": "message", - "subtype": "bot_message", - }, - "response_url": "https://hooks.slack.com/actions/..." - } - } -} -~~~ - - -\section customfacebookmessages Custom Facebook Messages -The Facebook adapter supports sending full attachments via the channelData field. This allows you to do anything -natively that Facebook supports via the attachment schema, such as receipt. - -| **Property** | **Description** -|---------| ----- -| * notification_type* | Push notification type: REGULAR, SILENT_PUSH, NO_PUSH -| * attachment* | A Facebook formatted attachment * See[Facebook Send API Reference](https://developers.facebook.com/docs/messenger-platform/send-api-reference#guidelines)* - -Example Message: - -~~~{.json} - - { - "type": "message", - "locale": "en-Us", - "text": "This is a test", - "channelID":"facebook", - "conversation": { "id":"123123123123", "topic":"awesome chat" }, - "from": { "id":"12345", "name":"My Bot"}, - "recipient": { "id":"67890", "name":"Joe Doe"}, - "channelData": - { - "notification_type" : "NO_PUSH", - "attachment": - { - "type":"template", - "payload": - { - "template_type":"receipt", - "recipient_name":"Stephane Crozatier", - "order_number":"12345678902", - "currency":"USD", - "payment_method":"Visa 2345", - "order_url":"http://petersapparel.parseapp.com/order?order_id=123456", - "timestamp":"1428444852", - "elements": - [ - { - "title":"Classic White T-Shirt", - "subtitle":"100% Soft and Luxurious Cotton", - "quantity":2, - "price":50, - "currency":"USD", - "image_url":"http://petersapparel.parseapp.com/img/whiteshirt.png" - }, - { - "title":"Classic Gray T-Shirt", - "subtitle":"100% Soft and Luxurious Cotton", - "quantity":1, - "price":25, - "currency":"USD", - "image_url":"http://petersapparel.parseapp.com/img/grayshirt.png" - } - ], - "address": - { - "street_1":"1 Hacker Way", - "street_2":"", - "city":"Menlo Park", - "postal_code":"94025", - "state":"CA", - "country":"US" - }, - "summary": - { - "subtotal":75.00, - "shipping_cost":4.95, - "total_tax":6.19, - "total_cost":56.14 - }, - "adjustments": - [ - { - "name":"New Customer Discount", - "amount":20 - }, - { - "name":"$10 Off Coupon", - "amount":10 - } - ] - } - } - } - } -~~~ - -\section customtelegrammessages Custom Telegram Messages - -The Telegram channel supports calling Telegram %Bot API methods via the channelData field. This allows your %bot to perform Telegram-specific actions, such as sharing a voice memo, or a sticker. - -| **Property** | **Description** -|---------| ----- -| *method* | The Telegram %Bot API method to call. See below for supported methods. -| *parameters* | Associative array containing method parameters. Parameters are method-specific. - ->See the [Telegram Bot API Documentation](https://core.telegram.org/bots/api) for a description of all available methods, parameters, and types. - - -Special Notes: - -1. The `chat_id` parameter is common to all Telegram methods.If not provided, the framework will fill in this value for you. -2. The Telegram channel expresses Telegram's `InputFile` type differently than the way it appears in the [Telegram Bot API](https://core.telegram.org/bots/api#inputfile). Rather than sending the file contents, your %bot should pass the file's `url` and `mediaType`. This is shown in the example message below. -3. When your %bot receives a %Connector message from the Telegram channel, the original Telegram message will be present in the channelData field. - -Example Message: - -~~~{.json} -{ - "type": "message", - "locale": "en-Us", - "channelID":"telegram", - "from": { "id":"12345", "name":"My Bot"}, - "recipient": { "id":"67890"}, "name":"Joe Doe"}, - "conversation": { "id":"123123123123", "topic":"awesome chat" }, - "channelData": - { - "method": "sendSticker", - "parameters": - { - "sticker": - { - "url": "https://upload.wikimedia.org/wikipedia/commons/3/33/LittleCarron.gif", - "mediaType": "image/gif" - } - } - } -} -~~~ - -You may pass multiple Telegram methods as an array: - -~~~{.json} -{ - "type": "message", - "locale": "en-Us", - "channelID":"telegram", - "from": { "id":"12345", "name":"My Bot"}, - "recipient": { "id":"67890"}, "name":"Joe Doe"}, - "conversation": { "id":"123123123123", "topic":"awesome chat" }, - "channelData": - [ - { - "method": "sendSticker", - "parameters": - { - "sticker": - { - "url": "http://www.gstatic.com/webp/gallery/1.webp", - "mediaType": "image/webp" - } - } - }, - { - "method": "sendMessage", - "parameters": - { - "text": "This message is HTML-formatted.", - "parse_mode": "HTML" - } - } - ] -} -~~~ - - -Supported Methods: - -| | | | -|---------|---------|---------| -| [sendMessage](https://core.telegram.org/bots/api#sendmessage) | [forwardMessage](https://core.telegram.org/bots/api#forwardmessage) | [sendPhoto](https://core.telegram.org/bots/api#sendphoto) -| [sendAudio](https://core.telegram.org/bots/api#sendaudio) | [sendDocument](https://core.telegram.org/bots/api#senddocument) | [sendSticker](https://core.telegram.org/bots/api#sendsticker) -| [sendVideo](https://core.telegram.org/bots/api#sendvideo) | [sendVoice](https://core.telegram.org/bots/api#sendvoice) | [sendLocation](https://core.telegram.org/bots/api#sendlocation) -| [sendVenue](https://core.telegram.org/bots/api#sendvenue) | [sendContact](https://core.telegram.org/bots/api#sendcontact) | [sendChatAction](https://core.telegram.org/bots/api#sendchataction) -| [kickChatMember](https://core.telegram.org/bots/api#kickchatmember) | [unbanChatMember](https://core.telegram.org/bots/api#unbanchatmember) | [answerInlineQuery](https://core.telegram.org/bots/api#answerinlinequery) -| [editMessageText](https://core.telegram.org/bots/api#editmessagetext) | [editMessageCaption](https://core.telegram.org/bots/api#editmessagecaption) | [editMessageReplyMarkup](https://core.telegram.org/bots/api#editmessagereplymarkup) - -\section customkikmessages Custom Kik Messages - -The Kik adapter supports sending native Kik messages via the channelData field. This allows you to do anything -natively that Kik supports. - -| **Property** | **Description** -|---------| ----- -| *messages* | An array of messages. *See [Kik Messages](https://dev.kik.com/#/docs/messaging#message-formats)* - -Example Message: - -~~~{.json} -{ - "type": "message", - "locale": "en-Us", - "channelID":"kik", - "from": { "id":"12345", "name":"My Bot"}, - "recipient": { "id":"67890"}, "name":"Joe Doe"}, - "conversation": { "id":"123123123123", "topic":"awesome chat" }, - "channelData": { - "messages": [ - { - "chatId": "c6dd81652051b8f02796e152422cce678a40d0fb6ad83acd8f91cae71d12f1e0", - "type": "link", - "to": "kikhandle", - "title": "My Webpage", - "text": "Some text to display", - "url": "http://botframework.com", - "picUrl": "http://lorempixel.com/400/200/", - "attribution": { - "name": "My App", - "iconUrl": "http://lorempixel.com/50/50/" - }, - "noForward": true, - "kikJsData": { - "key": "value" - } - } - ] - } -} -~~~ - - - **/ -} diff --git a/CSharp/Documentation/Conventions.cs b/CSharp/Documentation/Conventions.cs deleted file mode 100644 index 4e93a16130..0000000000 --- a/CSharp/Documentation/Conventions.cs +++ /dev/null @@ -1,74 +0,0 @@ -namespace Microsoft.Bot.Builder.Connector -{ - /** -\page connectormisc Conventions & Security - -\section serialization Class library vs. Serialization Conventions - -All of the objects described use lower-camel casing on the wire. The C# libraries use -strongly typed names that are pascal cased. Our documentation sometimes will use one or the -other but they are interchangeable. - -| **C# property** | wire serialization | javascript name | -| ----------------| ------------------ | --------------- | -| ReplyToId | replyToId | replyToId | - - -\subsection exampleserialization Example serialization -~~~{.json} - -{ - "type": "message", - "conversation": { - "Id": "GZxAXM39a6jdG0n2HQF5TEYL1vGgTG853w2259xn5VhGfs" - }, - "timestamp": "2016-03-22T04:19:11.2100568Z", - "channelid": "skype", - "text": "You said:test", - "attachments": [], - "from": { - "name": "Test Bot", - "id": "MyTestBot", - }, - "recipient": { - "name": "tom", - "id": "1hi3dbQ94Kddb", - }, - "locale": "en-Us", - "replyToId": "7TvTPn87HlZ", - "entities": [], -} - -~~~ - -\section securing Securing your bot - -Developers should ensure that their bot's endpoint can only be called by the %Bot %Connector. - -To do this you should -- Configure your endpoint to only use HTTPS -- Use the %Bot Framework SDK's authentication: MicrosoftAppId Password: MicrosoftAppPassword - -\subsection botauthattributes BotAuthentication Attribute -To make it easy for our C# developers we have created an attribute which does this for your method or controller. - -To use with the AppId and AppSecret coming from the web.config - -~~~{.cs} - [BotAuthentication] - public class MessagesController : ApiController - { - } -~~~ - -Or you can pass in the appId appSecret to the attribute directly: - -~~~{.cs} - [BotAuthentication(MicrosoftAppId = "_MicrosoftappId_")] - public class MessagesController : ApiController - { - } -~~~ - - **/ -} diff --git a/CSharp/Documentation/Dialogs.cs b/CSharp/Documentation/Dialogs.cs deleted file mode 100644 index 1019409435..0000000000 --- a/CSharp/Documentation/Dialogs.cs +++ /dev/null @@ -1,224 +0,0 @@ -namespace Microsoft.Bot.Builder.Dialogs -{ - /// \page dialogs %Dialogs - /// [LUIS]: http://luis.ai - /// [How to Setup LUIS]: http://aka.ms/bf-node-nl - /// [Buttons]: http://docs.botframework.com/connector/message-actions/#actions-on-attachments - /// - /// \section Overview - /// %Dialogs model a conversational process, where the exchange of messages between bot and user - /// is the primary channel for interaction with the outside world. Each dialog is an abstraction that encapsulates - /// its own state in a C# class that implements IDialog. %Dialogs can be composed with other dialogs to maximize reuse, - /// and a dialog context maintains a stack of dialogs active in the conversation. A conversation composed of dialogs is - /// portable across machines to make it possible to scale a bot implementation. This conversation state (the stack of - /// active dialogs and each dialog's state) is stored in the state service provided by the %Bot Connector service, making the bot - /// implementation stateless between requests. (Much like a web application that does not store session state in the - /// web server's memory.) - /// - /// The best way to understand this is to work through some examples. The first example changes the code in the - /// %Bot Framework template to use dialogs from the %Bot %Builder. The second example, \ref echoBot builds on that to - /// add some simple state. The final example \ref alarmBot uses the [LUIS] natural language framework and some of the - /// built-in system prompts. - /// - /// \section simpleEcho Echo Bot - /// This example starts with the bot you get by starting your bot the %Bot Framework template which includes code to - /// echo back what the user says. - /// In order to change the echo example to use the %Bot %Builder, we first need to import the required namespace: - /// ~~~ - /// using Microsoft.Bot.Builder.Dialogs; - /// ~~~ - /// - /// Next we need to add a C# class to represent our conversation. - /// You can do this by adding this class to your MessagesController.cs file: - /// \dontinclude SimpleEchoBot/Controllers/MessagesController.cs - /// \skip Serializable - /// \until } - /// \until } - /// \until } - /// - /// Finally we need to wire the class into your Post method like this: - /// \dontinclude SimpleEchoBot/Controllers/MessagesController.cs - /// \skip Post( - /// \until HandleSystemMessage - /// \until } - /// \until } - /// - /// The method is marked async because the %Bot %Builder makes use of the C# facilities for handling asynchronous communication. - /// It returns a Task which is representing the task responsible for sending replies for the passed in Message. - /// If there is an exception, the Task will contain the exception information. Within the Post method we call - /// Conversation.SendAsync which is the root method for the %Bot %Builder SDK. It follows the dependency - /// inversion principle (https://en.wikipedia.org/wiki/Dependency_inversion_principle) and does the following steps: - /// - Instantiate the required components. - /// - Deserialize the dialog state (the dialog stack and each dialog's state) from IBotDataStore (the default implementation uses the %Bot Connector state API as backing IBotDataStore). - /// - Resume the conversation processes where the %Bot decided to suspend and wait for a message. - /// - Send the replies. - /// - Serialize the updated dialog state and persist it back to IBotDataStore. - /// - /// When your conversation first starts, there is no dialog state in the IBotDataStore so the delegate passed to Conversation.SendAsync - /// will be used to construct an EchoDialog and it's StartAsync method will be called. In this case, StartAsync calls - /// IDialogContext.Wait with the continuation delegate (our MessageReceivedAsync method) to call when there is a new message. - /// In the initial case there is an immediate message available (the one that launched the dialog) and it is immediately - /// passed To MessageReceivedAsync. - /// - /// Within MessageReceivedAsync we wait for the message to come in and then post our response and wait for the next message. - /// In this simple case the next message would again be processed by MessageReceivedAsync. - /// Every time we call IDialogContext.Wait our bot is suspended and can be restarted on any machine that receives the message. - /// - /// If you run and test this bot, it will behave exactly like the original one from the %Bot Framework template. It is a - /// little more complicated, but it allows you to compose together multiple dialogs into complex conversations without - /// having to explicitly manage state. - /// - /// \section echoBot Echo Bot with State - /// Now that we have an example of the %Bot %Builder framework we are going to build on it to add some dialog state and - /// some commands to control that state. We are going to number the responses and allow the command "reset" to reset the - /// count. All we need to do is to replace our EchoDialog with the one below. - /// \dontinclude EchoBot/EchoDialog.cs - /// \skip Serializable - /// \until AfterResetAsync( - /// \until context.Wait - /// \until } - /// \until } - /// - /// The first change you will notice is the addition of `protected int count = 1;`. This is the state we are persisting - /// with this dialog on each message. - /// - /// In MessageReceivedAsync we have added check to see if the input was "reset" and if that is true we use the built-in - /// Prompts.Confirm dialog to spawn a sub-dialog that asks the user if they are sure about resetting the count. The sub-dialog has its - /// own private state and does not need to worry about interfering with the parent dialog. When the sub dialog - /// is done, it's result is then passed onto the AfterResetAync method. In AfterResetAsync we check on the - /// response and perform the action including sending a message back to the user. The final step is to do IDialogContext.Wait - /// with a continuation back to MessageReceivedAsync on the next message. - /// - /// \section alarmBot Alarm Bot - /// This example is more complex and shows how to integrate [LUIS] together with PromptDialog to create an alarm - /// system you can interact with through natural language. - /// In order to create a dialog that uses [LUIS] you need to create a class that derives from - /// LuisDialog like this: - /// \dontinclude SimpleAlarmBot/SimpleAlarmDialog.cs - /// \skip LuisModel - /// \until { - /// - /// The parameters to the LuisModel attribute are the [LUIS] REST endpoint and key. Here we have supplied - /// some values that will work, but the endpoint may be throttled in which case you will need to setup your own endpoint - /// as described in [How to Setup LUIS]. - /// - /// Within the SimpleAlarmDialog class any method with the name of the [LUIS] intent or marked with the LuisIntent attribute - /// is called when that intent is matched. For example here is the handler for turning off an - /// alarm, i.e. the intent "builtin.intent.alarm.turn_off_alarm": - /// \dontinclude SimpleAlarmBot/SimpleAlarmDialog.cs - /// \skip builtin.intent.alarm.turn_off_alarm - /// \until context.Wait - /// \until } - /// \until } - /// Within the handler you can see the confirmation done using the built-in Prompt.Confirm dialog. - /// The confirm dialog will spawn a sub-dialog for verifying the alarm deletion. Here is the full - /// example: - /// \include SimpleAlarmBot/SimpleAlarmDialog.cs - /// - /// \section IDialogContext - /// All of the dialogs take in an IDialogContext, an interface that provides the services - /// needed to save state and communicate. - /// The interface is composed of three interfaces: Internals.IBotData, Internals.IDialogStack, and Internals.IBotToUser. - /// - /// Internals.IBotData represents access to the per user, conversation, and private conversation, aka user in conversation state, maintained - /// by the %Bot Connector. The per user state is useful for storing things about the user that cross - /// conversations--for example the last sandwich order so that you can use that as the default - /// when ordering a sandwich. It is also possible to store such state in your own store - /// and use the Message.From.Id as a key. - /// - /// Internals.IBotToUser provides methods to post messages to be sent to the user, according to some policy. Some of these messages may be sent - /// inline with the response to the web api method call, and some of these messages may be sent directly using the %Bot Connector client. - /// Sending and receiving messages through the dialog context ensures the Internals.IBotData state is passed through the %Bot Connector. - /// - /// Internals.IDialogStack provides methods to: - /// - Call children dialogs and push the new child on the dialog stack. - /// - Mark the current dialog as done and return a result to the calling dialog and pop the current dialog from the dialog stack. - /// - Wait for a message from the user and suspend the conversation until the message arrives. - /// The stack is usually automatically managed for you. - /// - /// \section Serialization - /// - /// The dialog stack and the state of all active dialog are serialized to the per-user, per-conversation IBotDataBag. This serialized blob is persisted through - /// the Messages sent to and received from the %Bot Connector. Dialog classes must be marked with the serializable attribute so that Dialog object instances - /// can participate in the runtime serialization. For example, all of the IDialog implementations in the builder library are marked as serializable. - /// When custom serialization was desired, there is an ISerialization implementation and serialization constructor as well. - /// - /// The Chain methods provide a fluent interface to dialogs that is usable in LINQ query syntax. The compiled form of LINQ query syntax often leverages anonymous methods. - /// If these anonymous methods do not reference the environment of local variables, then these anonymous methods have no state and are trivially serializable. However, if - /// the anonymous method captures any local variable in the environment, the resulting closure object (generated by the compiler) is not marked as serializable. The %Bot %Builder - /// will detect this situation and throw a ClosureCaptureException to help diagnose the issue. - /// - /// If you wish to try to leverage reflection to serialize classes that are not marked as serializable, the library has a reflection-based serialization surrogate that - /// can be registered with Autofac as follows: - /// ~~~ - /// var builder = new ContainerBuilder(); - /// builder.RegisterModule(new DialogModule()); - /// builder.RegisterModule(new ReflectionSurrogateModule()); - /// ~~~ - /// - /// \section Fluent Dialog Chains - /// - /// Explicit management of the stack of active dialogs is possible through IDialogStack.Call and IDialogStack.Done, explicitly composing dialogs into a larger - /// conversation. It is also possible to implicitly manage the stack of active dialogs through the fluent Chain methods. - /// - /// Here is an overview of the chain methods, followed by some examples. - /// - /// Name | Type | Notes - /// ----- | ---- | ----- - /// Chain.Select | LINQ | Supports "select" and "let" in LINQ query syntax. - /// Chain.SelectMany | LINQ | Supports successive "from" in LINQ query syntax. - /// Chain.Where | LINQ | Supports "where" in LINQ query syntax. - /// Chain.From | Chains | Instantiates a new instance of a dialog. - /// Chain.Return | Chains | Return a constant value into the chain. - /// Chain.Do | Chains | Allow for side-effects within the chain. - /// Chain.ContinueWith | Chains | Simple chaining of dialogs. - /// Chain.Unwrap | Chains | Unwrap a dialog nested in a dialog. - /// Chain.DefaultIfException | Chains | Swallow exception from previous result and return default(T). - /// Chain.Loop | Branch | Loop the entire chain of dialogs. - /// Chain.Fold | Branch | Fold results from an enumeration of dialogs into a single result. - /// Chain.Switch | Branch | Support branching into different dialog chains. - /// Chain.PostToUser | Message | Post a message to the user. - /// Chain.WaitToBot | Message | Wait for a message to the bot. - /// Chain.PostToChain | Message | Start a chain with a message from the user. - /// - /// These Chain methods fall into a few buckets. - /// - /// LINQ query syntax starts off with the basic Chain.Select: - /// - /// \dontinclude Microsoft.Bot.Builder.Tests\ChainTests.cs - /// \skip MakeSelectQuery - /// \skip query - /// \until select - /// - /// and LINQ query syntax is enhanced with support for Chain.SelectMany: - /// - /// \dontinclude Microsoft.Bot.Builder.Tests\ChainTests.cs - /// \skip LinqQuerySyntax_Without_Reflection_Surrogate - /// \skip query - /// \until select - /// - /// Posting messages from the bot to the user and vice versa are supported by a Chain.PostToUser and Chain.WaitToBot: - /// - /// \dontinclude Microsoft.Bot.Builder.Tests\ChainTests.cs - /// \skip PostToUser - /// \until PostToUser - /// - /// Branching conversation dialog flow is supported by Chain.Switch: - /// - /// \dontinclude Microsoft.Bot.Builder.Tests\ChainTests.cs - /// \skip logic - /// \until ); - /// - /// If Chain.Switch returns a nested IDialog>, then the inner IDialog can be unwrapped with Chain.Unwrap. This allows for branching - /// in conversations to different paths of chained dialogs, possibly of unequal length. Here is a more complete example of branching dialogs written - /// in the fluent chain style with implicit stack management: - /// - /// \dontinclude Microsoft.Bot.Builder.Tests\ChainTests.cs - /// \skip joke - /// \until Loop - /// - /// \section Conclusion - /// Through this description we have seen how you can easily create stateless bots that can reuse dialog building blocks - /// ranging from simple prompts to advanced natural language. As a next step, you should explore \ref forms which - /// describes how the %Bot %Builder framework can automatically build dialogs from a C# class you want the user to fill in. -} diff --git a/CSharp/Documentation/Documentation.csproj b/CSharp/Documentation/Documentation.csproj deleted file mode 100644 index 82f72f9ba5..0000000000 --- a/CSharp/Documentation/Documentation.csproj +++ /dev/null @@ -1,116 +0,0 @@ - - - - $(ProgramW6432) - $(ProgramFiles) - $(MyProgramFiles)\doxygen\bin\doxygen.exe - True - $(MSBuildThisFileDirectory)Doxyfile - SAK - SAK - SAK - SAK - {72C60ACB-4804-4584-AD49-00289A89F227} - v4.6 - - publish\ - true - Disk - false - Foreground - 7 - Days - false - false - true - 0 - 1.0.0.%2a - false - false - true - - - True - false - - - - - - - - - - - - - - - - Designer - - - - - Always - - - - - - - - - - - - - - - {cebd91e9-cdbd-4cc2-adc1-8a5b626ce0ce} - Microsoft.Bot.Builder.Calling - - - {cdfec7d6-847e-4c13-956b-0a960ae3eb60} - Microsoft.Bot.Builder - - - {8674f271-4437-4178-b4e2-15f91b322e5d} - Microsoft.Bot.Builder.FormFlow.Json - - - - - - - - - - - - - - - - - - False - Microsoft .NET Framework 4.6 %28x86 and x64%29 - true - - - False - .NET Framework 3.5 SP1 - false - - - - - - - - - - - - \ No newline at end of file diff --git a/CSharp/Documentation/Doxyfile b/CSharp/Documentation/Doxyfile deleted file mode 100644 index c1de23f0d7..0000000000 --- a/CSharp/Documentation/Doxyfile +++ /dev/null @@ -1,2311 +0,0 @@ -# Doxyfile 1.8.7 - -# This file describes the settings to be used by the documentation system -# doxygen (www.doxygen.org) for a project. -# -# All text after a double hash (##) is considered a comment and is placed in -# front of the TAG it is preceding. -# -# All text after a single hash (#) is considered a comment and will be ignored. -# The format is: -# TAG = value [value, ...] -# For lists, items can also be appended using: -# TAG += value [value, ...] -# Values that contain spaces should be placed between quotes (\" \"). - -#--------------------------------------------------------------------------- -# Project related configuration options -#--------------------------------------------------------------------------- - -# This tag specifies the encoding used for all characters in the config file -# that follow. The default is UTF-8 which is also the encoding used for all text -# before the first occurrence of this tag. Doxygen uses libiconv (or the iconv -# built into libc) for the transcoding. See http://www.gnu.org/software/libiconv -# for the list of possible encodings. -# The default value is: UTF-8. - -DOXYFILE_ENCODING = UTF-8 - -# The PROJECT_NAME tag is a single word (or a sequence of words surrounded by -# double-quotes, unless you are using Doxywizard) that should identify the -# project for which the documentation is generated. This name is used in the -# title of most generated pages and in a few other places. -# The default value is: My Project. - -PROJECT_NAME = "Bot Builder for .NET" - -# The PROJECT_NUMBER tag can be used to enter a project or revision number. This -# could be handy for archiving the generated documentation or if some version -# control system is used. - -PROJECT_NUMBER = - -# Using the PROJECT_BRIEF tag one can provide an optional one line description -# for a project that appears at the top of each page and should give viewer a -# quick idea about the purpose of the project. Keep the description short. - -PROJECT_BRIEF = - -# With the PROJECT_LOGO tag one can specify an logo or icon that is included in -# the documentation. The maximum height of the logo should not exceed 55 pixels -# and the maximum width should not exceed 200 pixels. Doxygen will copy the logo -# to the output directory. - -PROJECT_LOGO = - -# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path -# into which the generated documentation will be written. If a relative path is -# entered, it will be relative to the location where doxygen was started. If -# left blank the current directory will be used. - -OUTPUT_DIRECTORY = ./docs - -# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create 4096 sub- -# directories (in 2 levels) under the output directory of each output format and -# will distribute the generated files over these directories. Enabling this -# option can be useful when feeding doxygen a huge amount of source files, where -# putting all generated files in the same directory would otherwise causes -# performance problems for the file system. -# The default value is: NO. - -CREATE_SUBDIRS = YES - -# The OUTPUT_LANGUAGE tag is used to specify the language in which all -# documentation generated by doxygen is written. Doxygen will use this -# information to generate all constant output in the proper language. -# Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese, -# Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States), -# Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian, -# Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages), -# Korean, Korean-en (Korean with English messages), Latvian, Lithuanian, -# Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian, -# Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish, -# Ukrainian and Vietnamese. -# The default value is: English. - -OUTPUT_LANGUAGE = English - -# If the BRIEF_MEMBER_DESC tag is set to YES doxygen will include brief member -# descriptions after the members that are listed in the file and class -# documentation (similar to Javadoc). Set to NO to disable this. -# The default value is: YES. - -BRIEF_MEMBER_DESC = YES - -# If the REPEAT_BRIEF tag is set to YES doxygen will prepend the brief -# description of a member or function before the detailed description -# -# Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the -# brief descriptions will be completely suppressed. -# The default value is: YES. - -REPEAT_BRIEF = YES - -# This tag implements a quasi-intelligent brief description abbreviator that is -# used to form the text in various listings. Each string in this list, if found -# as the leading text of the brief description, will be stripped from the text -# and the result, after processing the whole list, is used as the annotated -# text. Otherwise, the brief description is used as-is. If left blank, the -# following values are used ($name is automatically replaced with the name of -# the entity):The $name class, The $name widget, The $name file, is, provides, -# specifies, contains, represents, a, an and the. - -ABBREVIATE_BRIEF = - -# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then -# doxygen will generate a detailed section even if there is only a brief -# description. -# The default value is: NO. - -ALWAYS_DETAILED_SEC = NO - -# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all -# inherited members of a class in the documentation of that class as if those -# members were ordinary class members. Constructors, destructors and assignment -# operators of the base classes will not be shown. -# The default value is: NO. - -INLINE_INHERITED_MEMB = YES - -# If the FULL_PATH_NAMES tag is set to YES doxygen will prepend the full path -# before files name in the file list and in the header files. If set to NO the -# shortest path that makes the file name unique will be used -# The default value is: YES. - -FULL_PATH_NAMES = NO - -# The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path. -# Stripping is only done if one of the specified strings matches the left-hand -# part of the path. The tag can be used to show relative paths in the file list. -# If left blank the directory from which doxygen is run is used as the path to -# strip. -# -# Note that you can specify absolute paths here, but also relative paths, which -# will be relative from the directory where doxygen is started. -# This tag requires that the tag FULL_PATH_NAMES is set to YES. - -STRIP_FROM_PATH = - -# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the -# path mentioned in the documentation of a class, which tells the reader which -# header file to include in order to use a class. If left blank only the name of -# the header file containing the class definition is used. Otherwise one should -# specify the list of include paths that are normally passed to the compiler -# using the -I flag. - -STRIP_FROM_INC_PATH = - -# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but -# less readable) file names. This can be useful is your file systems doesn't -# support long names like on DOS, Mac, or CD-ROM. -# The default value is: NO. - -SHORT_NAMES = NO - -# If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the -# first line (until the first dot) of a Javadoc-style comment as the brief -# description. If set to NO, the Javadoc-style will behave just like regular Qt- -# style comments (thus requiring an explicit @brief command for a brief -# description.) -# The default value is: NO. - -JAVADOC_AUTOBRIEF = NO - -# If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first -# line (until the first dot) of a Qt-style comment as the brief description. If -# set to NO, the Qt-style will behave just like regular Qt-style comments (thus -# requiring an explicit \brief command for a brief description.) -# The default value is: NO. - -QT_AUTOBRIEF = NO - -# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a -# multi-line C++ special comment block (i.e. a block of //! or /// comments) as -# a brief description. This used to be the default behavior. The new default is -# to treat a multi-line C++ comment block as a detailed description. Set this -# tag to YES if you prefer the old behavior instead. -# -# Note that setting this tag to YES also means that rational rose comments are -# not recognized any more. -# The default value is: NO. - -MULTILINE_CPP_IS_BRIEF = NO - -# If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the -# documentation from any documented member that it re-implements. -# The default value is: YES. - -INHERIT_DOCS = YES - -# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce a -# new page for each member. If set to NO, the documentation of a member will be -# part of the file/class/namespace that contains it. -# The default value is: NO. - -SEPARATE_MEMBER_PAGES = NO - -# The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen -# uses this value to replace tabs by spaces in code fragments. -# Minimum value: 1, maximum value: 16, default value: 4. - -TAB_SIZE = 4 - -# This tag can be used to specify a number of aliases that act as commands in -# the documentation. An alias has the form: -# name=value -# For example adding -# "sideeffect=@par Side Effects:\n" -# will allow you to put the command \sideeffect (or @sideeffect) in the -# documentation, which will result in a user-defined paragraph with heading -# "Side Effects:". You can put \n's in the value part of an alias to insert -# newlines. - -ALIASES = - -# This tag can be used to specify a number of word-keyword mappings (TCL only). -# A mapping has the form "name=value". For example adding "class=itcl::class" -# will allow you to use the command class in the itcl::class meaning. - -TCL_SUBST = - -# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources -# only. Doxygen will then generate output that is more tailored for C. For -# instance, some of the names that are used will be different. The list of all -# members will be omitted, etc. -# The default value is: NO. - -OPTIMIZE_OUTPUT_FOR_C = NO - -# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or -# Python sources only. Doxygen will then generate output that is more tailored -# for that language. For instance, namespaces will be presented as packages, -# qualified scopes will look different, etc. -# The default value is: NO. - -OPTIMIZE_OUTPUT_JAVA = NO - -# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran -# sources. Doxygen will then generate output that is tailored for Fortran. -# The default value is: NO. - -OPTIMIZE_FOR_FORTRAN = NO - -# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL -# sources. Doxygen will then generate output that is tailored for VHDL. -# The default value is: NO. - -OPTIMIZE_OUTPUT_VHDL = NO - -# Doxygen selects the parser to use depending on the extension of the files it -# parses. With this tag you can assign which parser to use for a given -# extension. Doxygen has a built-in mapping, but you can override or extend it -# using this tag. The format is ext=language, where ext is a file extension, and -# language is one of the parsers supported by doxygen: IDL, Java, Javascript, -# C#, C, C++, D, PHP, Objective-C, Python, Fortran, VHDL. For instance to make -# doxygen treat .inc files as Fortran files (default is PHP), and .f files as C -# (default is Fortran), use: inc=Fortran f=C. -# -# Note For files without extension you can use no_extension as a placeholder. -# -# Note that for custom extensions you also need to set FILE_PATTERNS otherwise -# the files are not read by doxygen. - -EXTENSION_MAPPING = - -# If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments -# according to the Markdown format, which allows for more readable -# documentation. See http://daringfireball.net/projects/markdown/ for details. -# The output of markdown processing is further processed by doxygen, so you can -# mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in -# case of backward compatibilities issues. -# The default value is: YES. - -MARKDOWN_SUPPORT = YES - -# When enabled doxygen tries to link words that correspond to documented -# classes, or namespaces to their corresponding documentation. Such a link can -# be prevented in individual cases by by putting a % sign in front of the word -# or globally by setting AUTOLINK_SUPPORT to NO. -# The default value is: YES. - -AUTOLINK_SUPPORT = YES - -# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want -# to include (a tag file for) the STL sources as input, then you should set this -# tag to YES in order to let doxygen match functions declarations and -# definitions whose arguments contain STL classes (e.g. func(std::string); -# versus func(std::string) {}). This also make the inheritance and collaboration -# diagrams that involve STL classes more complete and accurate. -# The default value is: NO. - -BUILTIN_STL_SUPPORT = YES - -# If you use Microsoft's C++/CLI language, you should set this option to YES to -# enable parsing support. -# The default value is: NO. - -CPP_CLI_SUPPORT = YES - -# Set the SIP_SUPPORT tag to YES if your project consists of sip (see: -# http://www.riverbankcomputing.co.uk/software/sip/intro) sources only. Doxygen -# will parse them like normal C++ but will assume all classes use public instead -# of private inheritance when no explicit protection keyword is present. -# The default value is: NO. - -SIP_SUPPORT = NO - -# For Microsoft's IDL there are propget and propput attributes to indicate -# getter and setter methods for a property. Setting this option to YES will make -# doxygen to replace the get and set methods by a property in the documentation. -# This will only work if the methods are indeed getting or setting a simple -# type. If this is not the case, or you want to show the methods anyway, you -# should set this option to NO. -# The default value is: YES. - -IDL_PROPERTY_SUPPORT = YES - -# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC -# tag is set to YES, then doxygen will reuse the documentation of the first -# member in the group (if any) for the other members of the group. By default -# all members of a group must be documented explicitly. -# The default value is: NO. - -DISTRIBUTE_GROUP_DOC = NO - -# Set the SUBGROUPING tag to YES to allow class member groups of the same type -# (for instance a group of public functions) to be put as a subgroup of that -# type (e.g. under the Public Functions section). Set it to NO to prevent -# subgrouping. Alternatively, this can be done per class using the -# \nosubgrouping command. -# The default value is: YES. - -SUBGROUPING = YES - -# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions -# are shown inside the group in which they are included (e.g. using \ingroup) -# instead of on a separate page (for HTML and Man pages) or section (for LaTeX -# and RTF). -# -# Note that this feature does not work in combination with -# SEPARATE_MEMBER_PAGES. -# The default value is: NO. - -INLINE_GROUPED_CLASSES = NO - -# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions -# with only public data fields or simple typedef fields will be shown inline in -# the documentation of the scope in which they are defined (i.e. file, -# namespace, or group documentation), provided this scope is documented. If set -# to NO, structs, classes, and unions are shown on a separate page (for HTML and -# Man pages) or section (for LaTeX and RTF). -# The default value is: NO. - -INLINE_SIMPLE_STRUCTS = NO - -# When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or -# enum is documented as struct, union, or enum with the name of the typedef. So -# typedef struct TypeS {} TypeT, will appear in the documentation as a struct -# with name TypeT. When disabled the typedef will appear as a member of a file, -# namespace, or class. And the struct will be named TypeS. This can typically be -# useful for C code in case the coding convention dictates that all compound -# types are typedef'ed and only the typedef is referenced, never the tag name. -# The default value is: NO. - -TYPEDEF_HIDES_STRUCT = NO - -# The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This -# cache is used to resolve symbols given their name and scope. Since this can be -# an expensive process and often the same symbol appears multiple times in the -# code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small -# doxygen will become slower. If the cache is too large, memory is wasted. The -# cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range -# is 0..9, the default is 0, corresponding to a cache size of 2^16=65536 -# symbols. At the end of a run doxygen will report the cache usage and suggest -# the optimal cache size from a speed point of view. -# Minimum value: 0, maximum value: 9, default value: 0. - -LOOKUP_CACHE_SIZE = 2 - -#--------------------------------------------------------------------------- -# Build related configuration options -#--------------------------------------------------------------------------- - -# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in -# documentation are documented, even if no documentation was available. Private -# class members and static file members will be hidden unless the -# EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES. -# Note: This will also disable the warnings about undocumented members that are -# normally produced when WARNINGS is set to YES. -# The default value is: NO. - -EXTRACT_ALL = YES - -# If the EXTRACT_PRIVATE tag is set to YES all private members of a class will -# be included in the documentation. -# The default value is: NO. - -EXTRACT_PRIVATE = NO - -# If the EXTRACT_PACKAGE tag is set to YES all members with package or internal -# scope will be included in the documentation. -# The default value is: NO. - -EXTRACT_PACKAGE = NO - -# If the EXTRACT_STATIC tag is set to YES all static members of a file will be -# included in the documentation. -# The default value is: NO. - -EXTRACT_STATIC = YES - -# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) defined -# locally in source files will be included in the documentation. If set to NO -# only classes defined in header files are included. Does not have any effect -# for Java sources. -# The default value is: YES. - -EXTRACT_LOCAL_CLASSES = YES - -# This flag is only useful for Objective-C code. When set to YES local methods, -# which are defined in the implementation section but not in the interface are -# included in the documentation. If set to NO only methods in the interface are -# included. -# The default value is: NO. - -EXTRACT_LOCAL_METHODS = NO - -# If this flag is set to YES, the members of anonymous namespaces will be -# extracted and appear in the documentation as a namespace called -# 'anonymous_namespace{file}', where file will be replaced with the base name of -# the file that contains the anonymous namespace. By default anonymous namespace -# are hidden. -# The default value is: NO. - -EXTRACT_ANON_NSPACES = NO - -# If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all -# undocumented members inside documented classes or files. If set to NO these -# members will be included in the various overviews, but no documentation -# section is generated. This option has no effect if EXTRACT_ALL is enabled. -# The default value is: NO. - -HIDE_UNDOC_MEMBERS = NO - -# If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all -# undocumented classes that are normally visible in the class hierarchy. If set -# to NO these classes will be included in the various overviews. This option has -# no effect if EXTRACT_ALL is enabled. -# The default value is: NO. - -HIDE_UNDOC_CLASSES = NO - -# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend -# (class|struct|union) declarations. If set to NO these declarations will be -# included in the documentation. -# The default value is: NO. - -HIDE_FRIEND_COMPOUNDS = NO - -# If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any -# documentation blocks found inside the body of a function. If set to NO these -# blocks will be appended to the function's detailed documentation block. -# The default value is: NO. - -HIDE_IN_BODY_DOCS = NO - -# The INTERNAL_DOCS tag determines if documentation that is typed after a -# \internal command is included. If the tag is set to NO then the documentation -# will be excluded. Set it to YES to include the internal documentation. -# The default value is: NO. - -INTERNAL_DOCS = NO - -# If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file -# names in lower-case letters. If set to YES upper-case letters are also -# allowed. This is useful if you have classes or files whose names only differ -# in case and if your file system supports case sensitive file names. Windows -# and Mac users are advised to set this option to NO. -# The default value is: system dependent. - -CASE_SENSE_NAMES = NO - -# If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with -# their full class and namespace scopes in the documentation. If set to YES the -# scope will be hidden. -# The default value is: NO. - -HIDE_SCOPE_NAMES = NO - -# If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of -# the files that are included by a file in the documentation of that file. -# The default value is: YES. - -SHOW_INCLUDE_FILES = YES - -# If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each -# grouped member an include statement to the documentation, telling the reader -# which file to include in order to use the member. -# The default value is: NO. - -SHOW_GROUPED_MEMB_INC = NO - -# If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include -# files with double quotes in the documentation rather than with sharp brackets. -# The default value is: NO. - -FORCE_LOCAL_INCLUDES = NO - -# If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the -# documentation for inline members. -# The default value is: YES. - -INLINE_INFO = YES - -# If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the -# (detailed) documentation of file and class members alphabetically by member -# name. If set to NO the members will appear in declaration order. -# The default value is: YES. - -SORT_MEMBER_DOCS = YES - -# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief -# descriptions of file, namespace and class members alphabetically by member -# name. If set to NO the members will appear in declaration order. Note that -# this will also influence the order of the classes in the class list. -# The default value is: NO. - -SORT_BRIEF_DOCS = YES - -# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the -# (brief and detailed) documentation of class members so that constructors and -# destructors are listed first. If set to NO the constructors will appear in the -# respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS. -# Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief -# member documentation. -# Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting -# detailed member documentation. -# The default value is: NO. - -SORT_MEMBERS_CTORS_1ST = YES - -# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy -# of group names into alphabetical order. If set to NO the group names will -# appear in their defined order. -# The default value is: NO. - -SORT_GROUP_NAMES = NO - -# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by -# fully-qualified names, including namespaces. If set to NO, the class list will -# be sorted only by class name, not including the namespace part. -# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. -# Note: This option applies only to the class list, not to the alphabetical -# list. -# The default value is: NO. - -SORT_BY_SCOPE_NAME = YES - -# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper -# type resolution of all parameters of a function it will reject a match between -# the prototype and the implementation of a member function even if there is -# only one candidate or it is obvious which candidate to choose by doing a -# simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still -# accept a match between prototype and implementation in such cases. -# The default value is: NO. - -STRICT_PROTO_MATCHING = NO - -# The GENERATE_TODOLIST tag can be used to enable ( YES) or disable ( NO) the -# todo list. This list is created by putting \todo commands in the -# documentation. -# The default value is: YES. - -GENERATE_TODOLIST = YES - -# The GENERATE_TESTLIST tag can be used to enable ( YES) or disable ( NO) the -# test list. This list is created by putting \test commands in the -# documentation. -# The default value is: YES. - -GENERATE_TESTLIST = YES - -# The GENERATE_BUGLIST tag can be used to enable ( YES) or disable ( NO) the bug -# list. This list is created by putting \bug commands in the documentation. -# The default value is: YES. - -GENERATE_BUGLIST = YES - -# The GENERATE_DEPRECATEDLIST tag can be used to enable ( YES) or disable ( NO) -# the deprecated list. This list is created by putting \deprecated commands in -# the documentation. -# The default value is: YES. - -GENERATE_DEPRECATEDLIST= YES - -# The ENABLED_SECTIONS tag can be used to enable conditional documentation -# sections, marked by \if ... \endif and \cond -# ... \endcond blocks. - -ENABLED_SECTIONS = - -# The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the -# initial value of a variable or macro / define can have for it to appear in the -# documentation. If the initializer consists of more lines than specified here -# it will be hidden. Use a value of 0 to hide initializers completely. The -# appearance of the value of individual variables and macros / defines can be -# controlled using \showinitializer or \hideinitializer command in the -# documentation regardless of this setting. -# Minimum value: 0, maximum value: 10000, default value: 30. - -MAX_INITIALIZER_LINES = 30 - -# Set the SHOW_USED_FILES tag to NO to disable the list of files generated at -# the bottom of the documentation of classes and structs. If set to YES the list -# will mention the files that were used to generate the documentation. -# The default value is: YES. - -SHOW_USED_FILES = YES - -# Set the SHOW_FILES tag to NO to disable the generation of the Files page. This -# will remove the Files entry from the Quick Index and from the Folder Tree View -# (if specified). -# The default value is: YES. - -SHOW_FILES = NO - -# Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces -# page. This will remove the Namespaces entry from the Quick Index and from the -# Folder Tree View (if specified). -# The default value is: YES. - -SHOW_NAMESPACES = YES - -# The FILE_VERSION_FILTER tag can be used to specify a program or script that -# doxygen should invoke to get the current version for each file (typically from -# the version control system). Doxygen will invoke the program by executing (via -# popen()) the command command input-file, where command is the value of the -# FILE_VERSION_FILTER tag, and input-file is the name of an input file provided -# by doxygen. Whatever the program writes to standard output is used as the file -# version. For an example see the documentation. - -FILE_VERSION_FILTER = - -# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed -# by doxygen. The layout file controls the global structure of the generated -# output files in an output format independent way. To create the layout file -# that represents doxygen's defaults, run doxygen with the -l option. You can -# optionally specify a file name after the option, if omitted DoxygenLayout.xml -# will be used as the name of the layout file. -# -# Note that if you run doxygen from a directory containing a file called -# DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE -# tag is left empty. - -LAYOUT_FILE = ./DoxygenLayout.xml - -# The CITE_BIB_FILES tag can be used to specify one or more bib files containing -# the reference definitions. This must be a list of .bib files. The .bib -# extension is automatically appended if omitted. This requires the bibtex tool -# to be installed. See also http://en.wikipedia.org/wiki/BibTeX for more info. -# For LaTeX the style of the bibliography can be controlled using -# LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the -# search path. Do not use file names with spaces, bibtex cannot handle them. See -# also \cite for info how to create references. - -CITE_BIB_FILES = - -#--------------------------------------------------------------------------- -# Configuration options related to warning and progress messages -#--------------------------------------------------------------------------- - -# The QUIET tag can be used to turn on/off the messages that are generated to -# standard output by doxygen. If QUIET is set to YES this implies that the -# messages are off. -# The default value is: NO. - -QUIET = NO - -# The WARNINGS tag can be used to turn on/off the warning messages that are -# generated to standard error ( stderr) by doxygen. If WARNINGS is set to YES -# this implies that the warnings are on. -# -# Tip: Turn warnings on while writing the documentation. -# The default value is: YES. - -WARNINGS = YES - -# If the WARN_IF_UNDOCUMENTED tag is set to YES, then doxygen will generate -# warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag -# will automatically be disabled. -# The default value is: YES. - -WARN_IF_UNDOCUMENTED = YES - -# If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for -# potential errors in the documentation, such as not documenting some parameters -# in a documented function, or documenting parameters that don't exist or using -# markup commands wrongly. -# The default value is: YES. - -WARN_IF_DOC_ERROR = YES - -# This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that -# are documented, but have no documentation for their parameters or return -# value. If set to NO doxygen will only warn about wrong or incomplete parameter -# documentation, but not about the absence of documentation. -# The default value is: NO. - -WARN_NO_PARAMDOC = NO - -# The WARN_FORMAT tag determines the format of the warning messages that doxygen -# can produce. The string should contain the $file, $line, and $text tags, which -# will be replaced by the file and line number from which the warning originated -# and the warning text. Optionally the format may contain $version, which will -# be replaced by the version of the file (if it could be obtained via -# FILE_VERSION_FILTER) -# The default value is: $file:$line: $text. - -WARN_FORMAT = "$file:$line: $text" - -# The WARN_LOGFILE tag can be used to specify a file to which warning and error -# messages should be written. If left blank the output is written to standard -# error (stderr). - -WARN_LOGFILE = ./Doxygen_warnings.txt - -#--------------------------------------------------------------------------- -# Configuration options related to the input files -#--------------------------------------------------------------------------- - -# The INPUT tag is used to specify the files and/or directories that contain -# documented source files. You may enter file names like myfile.cpp or -# directories like /usr/src/myproject. Separate the files or directories with -# spaces. -# Note: If this tag is empty the current directory is searched. - -#../Library -INPUT = ../Library ./overview.cs ./connector.cs ./gettingstarted.cs ./routing.cs ./Activities.cs ./Attachments.cs ./Channels.cs ./StateAPI.cs ./conventions.cs ./dialogs.cs ./forms.cs ./calling.cs - -# This tag can be used to specify the character encoding of the source files -# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses -# libiconv (or the iconv built into libc) for the transcoding. See the libiconv -# documentation (see: http://www.gnu.org/software/libiconv) for the list of -# possible encodings. -# The default value is: UTF-8. - -INPUT_ENCODING = UTF-8 - -# If the value of the INPUT tag contains directories, you can use the -# FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and -# *.h) to filter out the source-files in the directories. If left blank the -# following patterns are tested:*.c, *.cc, *.cxx, *.cpp, *.c++, *.java, *.ii, -# *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, *.hh, *.hxx, *.hpp, -# *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, *.m, *.markdown, -# *.md, *.mm, *.dox, *.py, *.f90, *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf, -# *.qsf, *.as and *.js. - -FILE_PATTERNS = *.cs - -# The RECURSIVE tag can be used to specify whether or not subdirectories should -# be searched for input files as well. -# The default value is: NO. - -RECURSIVE = YES - -# The EXCLUDE tag can be used to specify files and/or directories that should be -# excluded from the INPUT source files. This way you can easily exclude a -# subdirectory from a directory tree whose root is specified with the INPUT tag. -# -# Note that relative paths are relative to the directory from which doxygen is -# run. - -EXCLUDE = ../Library/README.md - -# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or -# directories that are symbolic links (a Unix file system feature) are excluded -# from the input. -# The default value is: NO. - -EXCLUDE_SYMLINKS = NO - -# If the value of the INPUT tag contains directories, you can use the -# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude -# certain files from those directories. -# -# Note that the wildcards are matched against the file with absolute path, so to -# exclude all test directories for example use the pattern */test/* - -EXCLUDE_PATTERNS = */bin/* */obj/* */*.Tests/* */Documentation/* - -# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names -# (namespaces, classes, functions, etc.) that should be excluded from the -# output. The symbol name can be a fully qualified name, a word, or if the -# wildcard * is used, a substring. Examples: ANamespace, AClass, -# AClass::ANamespace, ANamespace::*Test -# -# Note that the wildcards are matched against the file with absolute path, so to -# exclude all test directories use the pattern */test/* - -EXCLUDE_SYMBOLS = - -# The EXAMPLE_PATH tag can be used to specify one or more files or directories -# that contain example code fragments that are included (see the \include -# command). - -EXAMPLE_PATH = ..\samples ..\tests - -# If the value of the EXAMPLE_PATH tag contains directories, you can use the -# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and -# *.h) to filter out the source-files in the directories. If left blank all -# files are included. - -EXAMPLE_PATTERNS = - -# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be -# searched for input files to be used with the \include or \dontinclude commands -# irrespective of the value of the RECURSIVE tag. -# The default value is: NO. - -EXAMPLE_RECURSIVE = NO - -# The IMAGE_PATH tag can be used to specify one or more files or directories -# that contain images that are to be included in the documentation (see the -# \image command). - -IMAGE_PATH = - -# The INPUT_FILTER tag can be used to specify a program that doxygen should -# invoke to filter for each input file. Doxygen will invoke the filter program -# by executing (via popen()) the command: -# -# -# -# where is the value of the INPUT_FILTER tag, and is the -# name of an input file. Doxygen will then use the output that the filter -# program writes to standard output. If FILTER_PATTERNS is specified, this tag -# will be ignored. -# -# Note that the filter must not add or remove lines; it is applied before the -# code is scanned, but not when the output code is generated. If lines are added -# or removed, the anchors will not be placed correctly. - -INPUT_FILTER = - -# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern -# basis. Doxygen will compare the file name with each pattern and apply the -# filter if there is a match. The filters are a list of the form: pattern=filter -# (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how -# filters are used. If the FILTER_PATTERNS tag is empty or if none of the -# patterns match the file name, INPUT_FILTER is applied. - -FILTER_PATTERNS = - -# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using -# INPUT_FILTER ) will also be used to filter the input files that are used for -# producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES). -# The default value is: NO. - -FILTER_SOURCE_FILES = NO - -# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file -# pattern. A pattern will override the setting for FILTER_PATTERN (if any) and -# it is also possible to disable source filtering for a specific pattern using -# *.ext= (so without naming a filter). -# This tag requires that the tag FILTER_SOURCE_FILES is set to YES. - -FILTER_SOURCE_PATTERNS = - -# If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that -# is part of the input, its contents will be placed on the main page -# (index.html). This can be useful if you have a project on for instance GitHub -# and want to reuse the introduction page also for the doxygen output. - -USE_MDFILE_AS_MAINPAGE = - -#--------------------------------------------------------------------------- -# Configuration options related to source browsing -#--------------------------------------------------------------------------- - -# If the SOURCE_BROWSER tag is set to YES then a list of source files will be -# generated. Documented entities will be cross-referenced with these sources. -# -# Note: To get rid of all source code in the generated output, make sure that -# also VERBATIM_HEADERS is set to NO. -# The default value is: NO. - -SOURCE_BROWSER = YES - -# Setting the INLINE_SOURCES tag to YES will include the body of functions, -# classes and enums directly into the documentation. -# The default value is: NO. - -INLINE_SOURCES = NO - -# Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any -# special comment blocks from generated source code fragments. Normal C, C++ and -# Fortran comments will always remain visible. -# The default value is: YES. - -STRIP_CODE_COMMENTS = YES - -# If the REFERENCED_BY_RELATION tag is set to YES then for each documented -# function all documented functions referencing it will be listed. -# The default value is: NO. - -REFERENCED_BY_RELATION = NO - -# If the REFERENCES_RELATION tag is set to YES then for each documented function -# all documented entities called/used by that function will be listed. -# The default value is: NO. - -REFERENCES_RELATION = NO - -# If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set -# to YES, then the hyperlinks from functions in REFERENCES_RELATION and -# REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will -# link to the documentation. -# The default value is: YES. - -REFERENCES_LINK_SOURCE = NO - -# If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the -# source code will show a tooltip with additional information such as prototype, -# brief description and links to the definition and documentation. Since this -# will make the HTML file larger and loading of large files a bit slower, you -# can opt to disable this feature. -# The default value is: YES. -# This tag requires that the tag SOURCE_BROWSER is set to YES. - -SOURCE_TOOLTIPS = YES - -# If the USE_HTAGS tag is set to YES then the references to source code will -# point to the HTML generated by the htags(1) tool instead of doxygen built-in -# source browser. The htags tool is part of GNU's global source tagging system -# (see http://www.gnu.org/software/global/global.html). You will need version -# 4.8.6 or higher. -# -# To use it do the following: -# - Install the latest version of global -# - Enable SOURCE_BROWSER and USE_HTAGS in the config file -# - Make sure the INPUT points to the root of the source tree -# - Run doxygen as normal -# -# Doxygen will invoke htags (and that will in turn invoke gtags), so these -# tools must be available from the command line (i.e. in the search path). -# -# The result: instead of the source browser generated by doxygen, the links to -# source code will now point to the output of htags. -# The default value is: NO. -# This tag requires that the tag SOURCE_BROWSER is set to YES. - -USE_HTAGS = NO - -# If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a -# verbatim copy of the header file for each class for which an include is -# specified. Set to NO to disable this. -# See also: Section \class. -# The default value is: YES. - -VERBATIM_HEADERS = YES - -# If the CLANG_ASSISTED_PARSING tag is set to YES, then doxygen will use the -# clang parser (see: http://clang.llvm.org/) for more acurate parsing at the -# cost of reduced performance. This can be particularly helpful with template -# rich C++ code for which doxygen's built-in parser lacks the necessary type -# information. -# Note: The availability of this option depends on whether or not doxygen was -# compiled with the --with-libclang option. -# The default value is: NO. - -CLANG_ASSISTED_PARSING = NO - -# If clang assisted parsing is enabled you can provide the compiler with command -# line options that you would normally use when invoking the compiler. Note that -# the include paths will already be set by doxygen for the files and directories -# specified with INPUT and INCLUDE_PATH. -# This tag requires that the tag CLANG_ASSISTED_PARSING is set to YES. - -CLANG_OPTIONS = - -#--------------------------------------------------------------------------- -# Configuration options related to the alphabetical class index -#--------------------------------------------------------------------------- - -# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all -# compounds will be generated. Enable this if the project contains a lot of -# classes, structs, unions or interfaces. -# The default value is: YES. - -ALPHABETICAL_INDEX = YES - -# The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in -# which the alphabetical index list will be split. -# Minimum value: 1, maximum value: 20, default value: 5. -# This tag requires that the tag ALPHABETICAL_INDEX is set to YES. - -COLS_IN_ALPHA_INDEX = 5 - -# In case all classes in a project start with a common prefix, all classes will -# be put under the same header in the alphabetical index. The IGNORE_PREFIX tag -# can be used to specify a prefix (or a list of prefixes) that should be ignored -# while generating the index headers. -# This tag requires that the tag ALPHABETICAL_INDEX is set to YES. - -IGNORE_PREFIX = - -#--------------------------------------------------------------------------- -# Configuration options related to the HTML output -#--------------------------------------------------------------------------- - -# If the GENERATE_HTML tag is set to YES doxygen will generate HTML output -# The default value is: YES. - -GENERATE_HTML = YES - -# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a -# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of -# it. -# The default directory is: html. -# This tag requires that the tag GENERATE_HTML is set to YES. - -HTML_OUTPUT = html - -# The HTML_FILE_EXTENSION tag can be used to specify the file extension for each -# generated HTML page (for example: .htm, .php, .asp). -# The default value is: .html. -# This tag requires that the tag GENERATE_HTML is set to YES. - -HTML_FILE_EXTENSION = .html - -# The HTML_HEADER tag can be used to specify a user-defined HTML header file for -# each generated HTML page. If the tag is left blank doxygen will generate a -# standard header. -# -# To get valid HTML the header file that includes any scripts and style sheets -# that doxygen needs, which is dependent on the configuration options used (e.g. -# the setting GENERATE_TREEVIEW). It is highly recommended to start with a -# default header using -# doxygen -w html new_header.html new_footer.html new_stylesheet.css -# YourConfigFile -# and then modify the file new_header.html. See also section "Doxygen usage" -# for information on how to generate the default header that doxygen normally -# uses. -# Note: The header is subject to change so you typically have to regenerate the -# default header when upgrading to a newer version of doxygen. For a description -# of the possible markers and block names see the documentation. -# This tag requires that the tag GENERATE_HTML is set to YES. - -HTML_HEADER = header.html - -# The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each -# generated HTML page. If the tag is left blank doxygen will generate a standard -# footer. See HTML_HEADER for more information on how to generate a default -# footer and what special commands can be used inside the footer. See also -# section "Doxygen usage" for information on how to generate the default footer -# that doxygen normally uses. -# This tag requires that the tag GENERATE_HTML is set to YES. - -HTML_FOOTER = footer.html - -# The HTML_STYLESHEET tag can be used to specify a user-defined cascading style -# sheet that is used by each HTML page. It can be used to fine-tune the look of -# the HTML output. If left blank doxygen will generate a default style sheet. -# See also section "Doxygen usage" for information on how to generate the style -# sheet that doxygen normally uses. -# Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as -# it is more robust and this tag (HTML_STYLESHEET) will in the future become -# obsolete. -# This tag requires that the tag GENERATE_HTML is set to YES. - -HTML_STYLESHEET = - -# The HTML_EXTRA_STYLESHEET tag can be used to specify an additional user- -# defined cascading style sheet that is included after the standard style sheets -# created by doxygen. Using this option one can overrule certain style aspects. -# This is preferred over using HTML_STYLESHEET since it does not replace the -# standard style sheet and is therefor more robust against future updates. -# Doxygen will copy the style sheet file to the output directory. For an example -# see the documentation. -# This tag requires that the tag GENERATE_HTML is set to YES. - -HTML_EXTRA_STYLESHEET = botframework.css - -# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or -# other source files which should be copied to the HTML output directory. Note -# that these files will be copied to the base HTML output directory. Use the -# $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these -# files. In the HTML_STYLESHEET file, use the file name only. Also note that the -# files will be copied as-is; there are no commands or markers available. -# This tag requires that the tag GENERATE_HTML is set to YES. - -HTML_EXTRA_FILES = - -# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen -# will adjust the colors in the stylesheet and background images according to -# this color. Hue is specified as an angle on a colorwheel, see -# http://en.wikipedia.org/wiki/Hue for more information. For instance the value -# 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300 -# purple, and 360 is red again. -# Minimum value: 0, maximum value: 359, default value: 220. -# This tag requires that the tag GENERATE_HTML is set to YES. - -HTML_COLORSTYLE_HUE = 220 - -# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors -# in the HTML output. For a value of 0 the output will use grayscales only. A -# value of 255 will produce the most vivid colors. -# Minimum value: 0, maximum value: 255, default value: 100. -# This tag requires that the tag GENERATE_HTML is set to YES. - -HTML_COLORSTYLE_SAT = 100 - -# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the -# luminance component of the colors in the HTML output. Values below 100 -# gradually make the output lighter, whereas values above 100 make the output -# darker. The value divided by 100 is the actual gamma applied, so 80 represents -# a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not -# change the gamma. -# Minimum value: 40, maximum value: 240, default value: 80. -# This tag requires that the tag GENERATE_HTML is set to YES. - -HTML_COLORSTYLE_GAMMA = 80 - -# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML -# page will contain the date and time when the page was generated. Setting this -# to NO can help when comparing the output of multiple runs. -# The default value is: YES. -# This tag requires that the tag GENERATE_HTML is set to YES. - -HTML_TIMESTAMP = YES - -# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML -# documentation will contain sections that can be hidden and shown after the -# page has loaded. -# The default value is: NO. -# This tag requires that the tag GENERATE_HTML is set to YES. - -HTML_DYNAMIC_SECTIONS = NO - -# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries -# shown in the various tree structured indices initially; the user can expand -# and collapse entries dynamically later on. Doxygen will expand the tree to -# such a level that at most the specified number of entries are visible (unless -# a fully collapsed tree already exceeds this amount). So setting the number of -# entries 1 will produce a full collapsed tree by default. 0 is a special value -# representing an infinite number of entries and will result in a full expanded -# tree by default. -# Minimum value: 0, maximum value: 9999, default value: 100. -# This tag requires that the tag GENERATE_HTML is set to YES. - -HTML_INDEX_NUM_ENTRIES = 100 - -# If the GENERATE_DOCSET tag is set to YES, additional index files will be -# generated that can be used as input for Apple's Xcode 3 integrated development -# environment (see: http://developer.apple.com/tools/xcode/), introduced with -# OSX 10.5 (Leopard). To create a documentation set, doxygen will generate a -# Makefile in the HTML output directory. Running make will produce the docset in -# that directory and running make install will install the docset in -# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at -# startup. See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html -# for more information. -# The default value is: NO. -# This tag requires that the tag GENERATE_HTML is set to YES. - -GENERATE_DOCSET = NO - -# This tag determines the name of the docset feed. A documentation feed provides -# an umbrella under which multiple documentation sets from a single provider -# (such as a company or product suite) can be grouped. -# The default value is: Doxygen generated docs. -# This tag requires that the tag GENERATE_DOCSET is set to YES. - -DOCSET_FEEDNAME = "Doxygen generated docs" - -# This tag specifies a string that should uniquely identify the documentation -# set bundle. This should be a reverse domain-name style string, e.g. -# com.mycompany.MyDocSet. Doxygen will append .docset to the name. -# The default value is: org.doxygen.Project. -# This tag requires that the tag GENERATE_DOCSET is set to YES. - -DOCSET_BUNDLE_ID = org.doxygen.Project - -# The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify -# the documentation publisher. This should be a reverse domain-name style -# string, e.g. com.mycompany.MyDocSet.documentation. -# The default value is: org.doxygen.Publisher. -# This tag requires that the tag GENERATE_DOCSET is set to YES. - -DOCSET_PUBLISHER_ID = org.doxygen.Publisher - -# The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher. -# The default value is: Publisher. -# This tag requires that the tag GENERATE_DOCSET is set to YES. - -DOCSET_PUBLISHER_NAME = Publisher - -# If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three -# additional HTML index files: index.hhp, index.hhc, and index.hhk. The -# index.hhp is a project file that can be read by Microsoft's HTML Help Workshop -# (see: http://www.microsoft.com/en-us/download/details.aspx?id=21138) on -# Windows. -# -# The HTML Help Workshop contains a compiler that can convert all HTML output -# generated by doxygen into a single compiled HTML file (.chm). Compiled HTML -# files are now used as the Windows 98 help format, and will replace the old -# Windows help format (.hlp) on all Windows platforms in the future. Compressed -# HTML files also contain an index, a table of contents, and you can search for -# words in the documentation. The HTML workshop also contains a viewer for -# compressed HTML files. -# The default value is: NO. -# This tag requires that the tag GENERATE_HTML is set to YES. - -GENERATE_HTMLHELP = NO - -# The CHM_FILE tag can be used to specify the file name of the resulting .chm -# file. You can add a path in front of the file if the result should not be -# written to the html output directory. -# This tag requires that the tag GENERATE_HTMLHELP is set to YES. - -CHM_FILE = - -# The HHC_LOCATION tag can be used to specify the location (absolute path -# including file name) of the HTML help compiler ( hhc.exe). If non-empty -# doxygen will try to run the HTML help compiler on the generated index.hhp. -# The file has to be specified with full path. -# This tag requires that the tag GENERATE_HTMLHELP is set to YES. - -HHC_LOCATION = - -# The GENERATE_CHI flag controls if a separate .chi index file is generated ( -# YES) or that it should be included in the master .chm file ( NO). -# The default value is: NO. -# This tag requires that the tag GENERATE_HTMLHELP is set to YES. - -GENERATE_CHI = NO - -# The CHM_INDEX_ENCODING is used to encode HtmlHelp index ( hhk), content ( hhc) -# and project file content. -# This tag requires that the tag GENERATE_HTMLHELP is set to YES. - -CHM_INDEX_ENCODING = - -# The BINARY_TOC flag controls whether a binary table of contents is generated ( -# YES) or a normal table of contents ( NO) in the .chm file. -# The default value is: NO. -# This tag requires that the tag GENERATE_HTMLHELP is set to YES. - -BINARY_TOC = NO - -# The TOC_EXPAND flag can be set to YES to add extra items for group members to -# the table of contents of the HTML help documentation and to the tree view. -# The default value is: NO. -# This tag requires that the tag GENERATE_HTMLHELP is set to YES. - -TOC_EXPAND = NO - -# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and -# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that -# can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help -# (.qch) of the generated HTML documentation. -# The default value is: NO. -# This tag requires that the tag GENERATE_HTML is set to YES. - -GENERATE_QHP = NO - -# If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify -# the file name of the resulting .qch file. The path specified is relative to -# the HTML output folder. -# This tag requires that the tag GENERATE_QHP is set to YES. - -QCH_FILE = - -# The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help -# Project output. For more information please see Qt Help Project / Namespace -# (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#namespace). -# The default value is: org.doxygen.Project. -# This tag requires that the tag GENERATE_QHP is set to YES. - -QHP_NAMESPACE = org.doxygen.Project - -# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt -# Help Project output. For more information please see Qt Help Project / Virtual -# Folders (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#virtual- -# folders). -# The default value is: doc. -# This tag requires that the tag GENERATE_QHP is set to YES. - -QHP_VIRTUAL_FOLDER = doc - -# If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom -# filter to add. For more information please see Qt Help Project / Custom -# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom- -# filters). -# This tag requires that the tag GENERATE_QHP is set to YES. - -QHP_CUST_FILTER_NAME = - -# The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the -# custom filter to add. For more information please see Qt Help Project / Custom -# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom- -# filters). -# This tag requires that the tag GENERATE_QHP is set to YES. - -QHP_CUST_FILTER_ATTRS = - -# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this -# project's filter section matches. Qt Help Project / Filter Attributes (see: -# http://qt-project.org/doc/qt-4.8/qthelpproject.html#filter-attributes). -# This tag requires that the tag GENERATE_QHP is set to YES. - -QHP_SECT_FILTER_ATTRS = - -# The QHG_LOCATION tag can be used to specify the location of Qt's -# qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the -# generated .qhp file. -# This tag requires that the tag GENERATE_QHP is set to YES. - -QHG_LOCATION = - -# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be -# generated, together with the HTML files, they form an Eclipse help plugin. To -# install this plugin and make it available under the help contents menu in -# Eclipse, the contents of the directory containing the HTML and XML files needs -# to be copied into the plugins directory of eclipse. The name of the directory -# within the plugins directory should be the same as the ECLIPSE_DOC_ID value. -# After copying Eclipse needs to be restarted before the help appears. -# The default value is: NO. -# This tag requires that the tag GENERATE_HTML is set to YES. - -GENERATE_ECLIPSEHELP = NO - -# A unique identifier for the Eclipse help plugin. When installing the plugin -# the directory name containing the HTML and XML files should also have this -# name. Each documentation set should have its own identifier. -# The default value is: org.doxygen.Project. -# This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES. - -ECLIPSE_DOC_ID = org.doxygen.Project - -# If you want full control over the layout of the generated HTML pages it might -# be necessary to disable the index and replace it with your own. The -# DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top -# of each HTML page. A value of NO enables the index and the value YES disables -# it. Since the tabs in the index contain the same information as the navigation -# tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES. -# The default value is: NO. -# This tag requires that the tag GENERATE_HTML is set to YES. - -DISABLE_INDEX = YES - -# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index -# structure should be generated to display hierarchical information. If the tag -# value is set to YES, a side panel will be generated containing a tree-like -# index structure (just like the one that is generated for HTML Help). For this -# to work a browser that supports JavaScript, DHTML, CSS and frames is required -# (i.e. any modern browser). Windows users are probably better off using the -# HTML help feature. Via custom stylesheets (see HTML_EXTRA_STYLESHEET) one can -# further fine-tune the look of the index. As an example, the default style -# sheet generated by doxygen has an example that shows how to put an image at -# the root of the tree instead of the PROJECT_NAME. Since the tree basically has -# the same information as the tab index, you could consider setting -# DISABLE_INDEX to YES when enabling this option. -# The default value is: NO. -# This tag requires that the tag GENERATE_HTML is set to YES. - -GENERATE_TREEVIEW = YES - -# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that -# doxygen will group on one line in the generated HTML documentation. -# -# Note that a value of 0 will completely suppress the enum values from appearing -# in the overview section. -# Minimum value: 0, maximum value: 20, default value: 4. -# This tag requires that the tag GENERATE_HTML is set to YES. - -ENUM_VALUES_PER_LINE = 4 - -# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used -# to set the initial width (in pixels) of the frame in which the tree is shown. -# Minimum value: 0, maximum value: 1500, default value: 250. -# This tag requires that the tag GENERATE_HTML is set to YES. - -TREEVIEW_WIDTH = 250 - -# When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open links to -# external symbols imported via tag files in a separate window. -# The default value is: NO. -# This tag requires that the tag GENERATE_HTML is set to YES. - -EXT_LINKS_IN_WINDOW = NO - -# Use this tag to change the font size of LaTeX formulas included as images in -# the HTML documentation. When you change the font size after a successful -# doxygen run you need to manually remove any form_*.png images from the HTML -# output directory to force them to be regenerated. -# Minimum value: 8, maximum value: 50, default value: 10. -# This tag requires that the tag GENERATE_HTML is set to YES. - -FORMULA_FONTSIZE = 10 - -# Use the FORMULA_TRANPARENT tag to determine whether or not the images -# generated for formulas are transparent PNGs. Transparent PNGs are not -# supported properly for IE 6.0, but are supported on all modern browsers. -# -# Note that when changing this option you need to delete any form_*.png files in -# the HTML output directory before the changes have effect. -# The default value is: YES. -# This tag requires that the tag GENERATE_HTML is set to YES. - -FORMULA_TRANSPARENT = YES - -# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see -# http://www.mathjax.org) which uses client side Javascript for the rendering -# instead of using prerendered bitmaps. Use this if you do not have LaTeX -# installed or if you want to formulas look prettier in the HTML output. When -# enabled you may also need to install MathJax separately and configure the path -# to it using the MATHJAX_RELPATH option. -# The default value is: NO. -# This tag requires that the tag GENERATE_HTML is set to YES. - -USE_MATHJAX = YES - -# When MathJax is enabled you can set the default output format to be used for -# the MathJax output. See the MathJax site (see: -# http://docs.mathjax.org/en/latest/output.html) for more details. -# Possible values are: HTML-CSS (which is slower, but has the best -# compatibility), NativeMML (i.e. MathML) and SVG. -# The default value is: HTML-CSS. -# This tag requires that the tag USE_MATHJAX is set to YES. - -MATHJAX_FORMAT = HTML-CSS - -# When MathJax is enabled you need to specify the location relative to the HTML -# output directory using the MATHJAX_RELPATH option. The destination directory -# should contain the MathJax.js script. For instance, if the mathjax directory -# is located at the same level as the HTML output directory, then -# MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax -# Content Delivery Network so you can quickly see the result without installing -# MathJax. However, it is strongly recommended to install a local copy of -# MathJax from http://www.mathjax.org before deployment. -# The default value is: http://cdn.mathjax.org/mathjax/latest. -# This tag requires that the tag USE_MATHJAX is set to YES. - -MATHJAX_RELPATH = https://cdn.mathjax.org/mathjax/latest - -# The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax -# extension names that should be enabled during MathJax rendering. For example -# MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols -# This tag requires that the tag USE_MATHJAX is set to YES. - -MATHJAX_EXTENSIONS = - -# The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces -# of code that will be used on startup of the MathJax code. See the MathJax site -# (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an -# example see the documentation. -# This tag requires that the tag USE_MATHJAX is set to YES. - -MATHJAX_CODEFILE = - -# When the SEARCHENGINE tag is enabled doxygen will generate a search box for -# the HTML output. The underlying search engine uses javascript and DHTML and -# should work on any modern browser. Note that when using HTML help -# (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET) -# there is already a search function so this one should typically be disabled. -# For large projects the javascript based search engine can be slow, then -# enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to -# search using the keyboard; to jump to the search box use + S -# (what the is depends on the OS and browser, but it is typically -# , /