Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: generate docs #384

Merged
merged 2 commits into from
Feb 10, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
2 changes: 1 addition & 1 deletion Doxyfile
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ PROJECT_NAME = "Zeebe C# Client"
# could be handy for archiving the generated documentation or if some version
# control system is used.

PROJECT_NUMBER = 1.0.0
PROJECT_NUMBER = 1.2.1

# 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
Expand Down
83 changes: 41 additions & 42 deletions docs/annotated.html

Large diffs are not rendered by default.

10 changes: 5 additions & 5 deletions docs/annotated_dup.js

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

31 changes: 15 additions & 16 deletions docs/classes.html

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.9.1"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.3"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Zeebe C# Client: Zeebe.Client.Api.Commands.IResolveIncidentCommandStep1 Interface Reference</title>
<link href="../../tabs.css" rel="stylesheet" type="text/css"/>
Expand All @@ -23,11 +23,10 @@
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<tr id="projectrow">
<td id="projectlogo"><img alt="Logo" src="../../zeebe-logo.png"/></td>
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">Zeebe C# Client
&#160;<span id="projectnumber">1.0.0</span>
<td id="projectalign">
<div id="projectname">Zeebe C# Client<span id="projectnumber">&#160;1.2.1</span>
</div>
<div id="projectbrief">C# Client to communicate with an Zeebe Gateway</div>
</td>
Expand All @@ -36,21 +35,22 @@
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.1 -->
<!-- Generated by Doxygen 1.9.3 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "../../search",false,'Search','.html');
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "../../search",'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="../../menudata.js"></script>
<script type="text/javascript" src="../../menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
initMenu('../../',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
/* @license-end */
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
Expand All @@ -64,7 +64,7 @@
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(document).ready(function(){initNavTree('d0/d39/interfaceZeebe_1_1Client_1_1Api_1_1Commands_1_1IResolveIncidentCommandStep1.html','../../'); initResizable(); });
/* @license-end */
</script>
Expand All @@ -86,8 +86,7 @@
<div class="header">
<div class="summary">
<a href="../../d4/d48/interfaceZeebe_1_1Client_1_1Api_1_1Commands_1_1IResolveIncidentCommandStep1-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">Zeebe.Client.Api.Commands.IResolveIncidentCommandStep1 Interface Reference</div> </div>
<div class="headertitle"><div class="title">Zeebe.Client.Api.Commands.IResolveIncidentCommandStep1 Interface Reference</div></div>
</div><!--header-->
<div class="contents">
<div class="dynheader">
Expand All @@ -96,19 +95,16 @@
<div class="center">
<img src="../../d0/d39/interfaceZeebe_1_1Client_1_1Api_1_1Commands_1_1IResolveIncidentCommandStep1.png" usemap="#Zeebe.Client.Api.Commands.IResolveIncidentCommandStep1_map" alt=""/>
<map id="Zeebe.Client.Api.Commands.IResolveIncidentCommandStep1_map" name="Zeebe.Client.Api.Commands.IResolveIncidentCommandStep1_map">
<area href="../../d2/de4/interfaceZeebe_1_1Client_1_1Api_1_1Commands_1_1IFinalCommandStep.html" alt="Zeebe.Client.Api.Commands.IFinalCommandStep&lt; IResolveIncidentResponse &gt;" shape="rect" coords="0,0,459,24"/>
<area href="../../d5/d5e/interfaceZeebe_1_1Client_1_1Api_1_1Commands_1_1IFinalCommandWithRetryStep.html" alt="Zeebe.Client.Api.Commands.IFinalCommandWithRetryStep&lt; IResolveIncidentResponse &gt;" shape="rect" coords="0,0,513,24"/>
</map>
</div></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="inherited"></a>
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="inherited" name="inherited"></a>
Additional Inherited Members</h2></td></tr>
<tr class="inherit_header pub_methods_interfaceZeebe_1_1Client_1_1Api_1_1Commands_1_1IFinalCommandStep"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_interfaceZeebe_1_1Client_1_1Api_1_1Commands_1_1IFinalCommandStep')"><img src="../../closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="../../d2/de4/interfaceZeebe_1_1Client_1_1Api_1_1Commands_1_1IFinalCommandStep.html">Zeebe.Client.Api.Commands.IFinalCommandStep&lt; IResolveIncidentResponse &gt;</a></td></tr>
<tr class="memitem:adc0ff5f12e104c7086bb5e8c821b0dba inherit pub_methods_interfaceZeebe_1_1Client_1_1Api_1_1Commands_1_1IFinalCommandStep"><td class="memItemLeft" align="right" valign="top">Task&lt; T &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d2/de4/interfaceZeebe_1_1Client_1_1Api_1_1Commands_1_1IFinalCommandStep.html#adc0ff5f12e104c7086bb5e8c821b0dba">Send</a> (TimeSpan? timeout=null, CancellationToken token=default)</td></tr>
<tr class="memdesc:adc0ff5f12e104c7086bb5e8c821b0dba inherit pub_methods_interfaceZeebe_1_1Client_1_1Api_1_1Commands_1_1IFinalCommandStep"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sends the command to the <a class="el" href="../../d6/d18/namespaceZeebe.html">Zeebe</a> broker. This operation is asynchronous. In case of success, the task returns the event that was generated by the <a class="el" href="../../d6/d18/namespaceZeebe.html">Zeebe</a> broker in response to the command. <a href="../../d2/de4/interfaceZeebe_1_1Client_1_1Api_1_1Commands_1_1IFinalCommandStep.html#adc0ff5f12e104c7086bb5e8c821b0dba">More...</a><br /></td></tr>
<tr class="separator:adc0ff5f12e104c7086bb5e8c821b0dba inherit pub_methods_interfaceZeebe_1_1Client_1_1Api_1_1Commands_1_1IFinalCommandStep"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a922dde6f442d6d80b648549b5b226734 inherit pub_methods_interfaceZeebe_1_1Client_1_1Api_1_1Commands_1_1IFinalCommandStep"><td class="memItemLeft" align="right" valign="top">Task&lt; T &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d2/de4/interfaceZeebe_1_1Client_1_1Api_1_1Commands_1_1IFinalCommandStep.html#a922dde6f442d6d80b648549b5b226734">Send</a> (CancellationToken cancellationToken)</td></tr>
<tr class="memdesc:a922dde6f442d6d80b648549b5b226734 inherit pub_methods_interfaceZeebe_1_1Client_1_1Api_1_1Commands_1_1IFinalCommandStep"><td class="mdescLeft">&#160;</td><td class="mdescRight">Convenient method, which delegates to <code>Send(TimeSpan? timeout = null, CancellationToken token = default)</code>. <a href="../../d2/de4/interfaceZeebe_1_1Client_1_1Api_1_1Commands_1_1IFinalCommandStep.html#a922dde6f442d6d80b648549b5b226734">More...</a><br /></td></tr>
<tr class="separator:a922dde6f442d6d80b648549b5b226734 inherit pub_methods_interfaceZeebe_1_1Client_1_1Api_1_1Commands_1_1IFinalCommandStep"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_interfaceZeebe_1_1Client_1_1Api_1_1Commands_1_1IFinalCommandWithRetryStep"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_interfaceZeebe_1_1Client_1_1Api_1_1Commands_1_1IFinalCommandWithRetryStep')"><img src="../../closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="../../d5/d5e/interfaceZeebe_1_1Client_1_1Api_1_1Commands_1_1IFinalCommandWithRetryStep.html">Zeebe.Client.Api.Commands.IFinalCommandWithRetryStep&lt; IResolveIncidentResponse &gt;</a></td></tr>
<tr class="memitem:a00faa4eeae2f6a2d2dc18e2d1153b214 inherit pub_methods_interfaceZeebe_1_1Client_1_1Api_1_1Commands_1_1IFinalCommandWithRetryStep"><td class="memItemLeft" align="right" valign="top">Task&lt; T &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d5/d5e/interfaceZeebe_1_1Client_1_1Api_1_1Commands_1_1IFinalCommandWithRetryStep.html#a00faa4eeae2f6a2d2dc18e2d1153b214">SendWithRetry</a> (TimeSpan? timeout=null, CancellationToken token=default)</td></tr>
<tr class="memdesc:a00faa4eeae2f6a2d2dc18e2d1153b214 inherit pub_methods_interfaceZeebe_1_1Client_1_1Api_1_1Commands_1_1IFinalCommandWithRetryStep"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sends the command with retry to the <a class="el" href="../../d6/d18/namespaceZeebe.html">Zeebe</a> broker. This operation is asynchronous. In case of success, the task returns the event that was generated by the <a class="el" href="../../d6/d18/namespaceZeebe.html">Zeebe</a> broker in response to the command. If the sending of the command fails, because of broker back pressure or network issues the request is retried until the command succeeds. The wait time between retries can be configured on the ZeebeClientBuilder. Per default the wait time is based on power two, which means 2^1 seconds, 2^2 seconds etc. until it reaches the maximum of one minute. <a href="../../d5/d5e/interfaceZeebe_1_1Client_1_1Api_1_1Commands_1_1IFinalCommandWithRetryStep.html#a00faa4eeae2f6a2d2dc18e2d1153b214">More...</a><br /></td></tr>
<tr class="separator:a00faa4eeae2f6a2d2dc18e2d1153b214 inherit pub_methods_interfaceZeebe_1_1Client_1_1Api_1_1Commands_1_1IFinalCommandWithRetryStep"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<hr/>The documentation for this interface was generated from the following file:<ul>
<li>Client/Api/Commands/IResolveIncidentCommandStep1.cs</li>
Expand All @@ -119,7 +115,7 @@
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="../../d6/d18/namespaceZeebe.html">Zeebe</a></li><li class="navelem"><a class="el" href="../../da/d88/namespaceZeebe_1_1Client.html">Client</a></li><li class="navelem"><a class="el" href="../../d5/df7/namespaceZeebe_1_1Client_1_1Api.html">Api</a></li><li class="navelem"><a class="el" href="../../d9/def/namespaceZeebe_1_1Client_1_1Api_1_1Commands.html">Commands</a></li><li class="navelem"><a class="el" href="../../d0/d39/interfaceZeebe_1_1Client_1_1Api_1_1Commands_1_1IResolveIncidentCommandStep1.html">IResolveIncidentCommandStep1</a></li>
<li class="footer">Generated on Tue May 11 2021 15:19:16 for Zeebe C# Client by <a href="https://www.doxygen.org/index.html"><img class="footer" src="../../doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1 </li>
<li class="footer">Generated on Thu Feb 10 2022 06:33:24 for Zeebe C# Client by <a href="https://www.doxygen.org/index.html"><img class="footer" src="../../doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.3 </li>
</ul>
</div>
</body>
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading