Skip to content

Commit

Permalink
docs: generate docs
Browse files Browse the repository at this point in the history
  • Loading branch information
ChrisKujawa committed Feb 1, 2024
1 parent ae8b99b commit 955227f
Show file tree
Hide file tree
Showing 205 changed files with 2,522 additions and 738 deletions.
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 = 2.4.0
PROJECT_NUMBER = 2.5.0

# 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
91 changes: 48 additions & 43 deletions docs/annotated.html

Large diffs are not rendered by default.

7 changes: 6 additions & 1 deletion docs/annotated_dup.js

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

6 changes: 3 additions & 3 deletions docs/classes.html

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions docs/d0/d12/interfaceIDecisionRequirementsMetadata.html
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@
<tr id="projectrow">
<td id="projectlogo"><img alt="Logo" src="../../zeebe-logo.png"/></td>
<td id="projectalign">
<div id="projectname">Zeebe C# Client<span id="projectnumber">&#160;2.4.0</span>
<div id="projectname">Zeebe C# Client<span id="projectnumber">&#160;2.5.0</span>
</div>
<div id="projectbrief">C# Client to communicate with an Zeebe Gateway</div>
</td>
Expand Down Expand Up @@ -196,7 +196,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#a703fdf9cd478efd8cc4c87ae
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="../../d0/d12/interfaceIDecisionRequirementsMetadata.html">IDecisionRequirementsMetadata</a></li>
<li class="footer">Generated on Fri Dec 15 2023 17:11:57 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.5 </li>
<li class="footer">Generated on Thu Feb 1 2024 15:47:54 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.5 </li>
</ul>
</div>
</body>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@
<tr id="projectrow">
<td id="projectlogo"><img alt="Logo" src="../../zeebe-logo.png"/></td>
<td id="projectalign">
<div id="projectname">Zeebe C# Client<span id="projectnumber">&#160;2.4.0</span>
<div id="projectname">Zeebe C# Client<span id="projectnumber">&#160;2.5.0</span>
</div>
<div id="projectbrief">C# Client to communicate with an Zeebe Gateway</div>
</td>
Expand Down Expand Up @@ -122,7 +122,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 Fri Dec 15 2023 17:11:57 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.5 </li>
<li class="footer">Generated on Thu Feb 1 2024 15:47:54 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.5 </li>
</ul>
</div>
</body>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@
<tr id="projectrow">
<td id="projectlogo"><img alt="Logo" src="../../zeebe-logo.png"/></td>
<td id="projectalign">
<div id="projectname">Zeebe C# Client<span id="projectnumber">&#160;2.4.0</span>
<div id="projectname">Zeebe C# Client<span id="projectnumber">&#160;2.5.0</span>
</div>
<div id="projectbrief">C# Client to communicate with an Zeebe Gateway</div>
</td>
Expand Down Expand Up @@ -103,7 +103,7 @@
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="footer">Generated on Fri Dec 15 2023 17:11:57 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.5 </li>
<li class="footer">Generated on Thu Feb 1 2024 15:47:54 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.5 </li>
</ul>
</div>
</body>
Expand Down
207 changes: 207 additions & 0 deletions docs/d0/d4b/interfaceIModifyProcessInstanceCommandStep3.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,207 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.5"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Zeebe C# Client: IModifyProcessInstanceCommandStep3 Interface Reference</title>
<link href="../../tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="../../jquery.js"></script>
<script type="text/javascript" src="../../dynsections.js"></script>
<link href="../../navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="../../resize.js"></script>
<script type="text/javascript" src="../../navtreedata.js"></script>
<script type="text/javascript" src="../../navtree.js"></script>
<link href="../../search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="../../search/searchdata.js"></script>
<script type="text/javascript" src="../../search/search.js"></script>
<link href="../../doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr id="projectrow">
<td id="projectlogo"><img alt="Logo" src="../../zeebe-logo.png"/></td>
<td id="projectalign">
<div id="projectname">Zeebe C# Client<span id="projectnumber">&#160;2.5.0</span>
</div>
<div id="projectbrief">C# Client to communicate with an Zeebe Gateway</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.5 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "../../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:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
initMenu('../../',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(document).ready(function(){initNavTree('d0/d4b/interfaceIModifyProcessInstanceCommandStep3.html','../../'); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>

<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="../../d3/d3f/interfaceIModifyProcessInstanceCommandStep3-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">IModifyProcessInstanceCommandStep3 Interface Reference</div></div>
</div><!--header-->
<div class="contents">

<p>Third command step, to optionally add variables to the element which should be activated.
<a href="../../d0/d4b/interfaceIModifyProcessInstanceCommandStep3.html#details">More...</a></p>
<div class="dynheader">
Inheritance diagram for IModifyProcessInstanceCommandStep3:</div>
<div class="dyncontent">
<div class="center">
<img src="../../d0/d4b/interfaceIModifyProcessInstanceCommandStep3.png" usemap="#IModifyProcessInstanceCommandStep3_map" alt=""/>
<map id="IModifyProcessInstanceCommandStep3_map" name="IModifyProcessInstanceCommandStep3_map">
<area href="../../df/db2/interfaceIModifyProcessInstanceCommandStep2.html" title="Second command step, to optional add more instructions to activate or terminate." alt="IModifyProcessInstanceCommandStep2" shape="rect" coords="0,56,391,80"/>
</map>
</div></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:afc5466763091e86797d2d4b7d91b1a39"><td class="memItemLeft" align="right" valign="top"><a class="el" href="../../d0/d4b/interfaceIModifyProcessInstanceCommandStep3.html">IModifyProcessInstanceCommandStep3</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d0/d4b/interfaceIModifyProcessInstanceCommandStep3.html#afc5466763091e86797d2d4b7d91b1a39">WithVariables</a> (string variables)</td></tr>
<tr class="memdesc:afc5466763091e86797d2d4b7d91b1a39"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create a variable instruction for the element that's getting activated. These variables will be created in the global scope of the process instance. <a href="../../d0/d4b/interfaceIModifyProcessInstanceCommandStep3.html#afc5466763091e86797d2d4b7d91b1a39">More...</a><br /></td></tr>
<tr class="separator:afc5466763091e86797d2d4b7d91b1a39"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a77b27701c3be61c204cb02d496636cbe"><td class="memItemLeft" align="right" valign="top"><a class="el" href="../../d0/d4b/interfaceIModifyProcessInstanceCommandStep3.html">IModifyProcessInstanceCommandStep3</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d0/d4b/interfaceIModifyProcessInstanceCommandStep3.html#a77b27701c3be61c204cb02d496636cbe">WithVariables</a> (string variables, string scopeId)</td></tr>
<tr class="memdesc:a77b27701c3be61c204cb02d496636cbe"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create a variable instruction for the element that's getting activated. These variables will be created in the scope of the passed element. <a href="../../d0/d4b/interfaceIModifyProcessInstanceCommandStep3.html#a77b27701c3be61c204cb02d496636cbe">More...</a><br /></td></tr>
<tr class="separator:a77b27701c3be61c204cb02d496636cbe"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_interfaceIModifyProcessInstanceCommandStep2"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_interfaceIModifyProcessInstanceCommandStep2')"><img src="../../closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="../../df/db2/interfaceIModifyProcessInstanceCommandStep2.html">IModifyProcessInstanceCommandStep2</a></td></tr>
<tr class="memitem:a89d2f1ff2f16b051743b433990113b1a inherit pub_methods_interfaceIModifyProcessInstanceCommandStep2"><td class="memItemLeft" align="right" valign="top"><a class="el" href="../../dd/d24/interfaceIModifyProcessInstanceCommandStep1.html">IModifyProcessInstanceCommandStep1</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../df/db2/interfaceIModifyProcessInstanceCommandStep2.html#a89d2f1ff2f16b051743b433990113b1a">And</a> ()</td></tr>
<tr class="memdesc:a89d2f1ff2f16b051743b433990113b1a inherit pub_methods_interfaceIModifyProcessInstanceCommandStep2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Acts as a boundary between the different activate and terminate instructions. Use this if you want to activate or terminate another element. Otherwise, use IFinalCommandWithRetryStep&lt;T&gt;.SendWithRetry to send the command. <a href="../../df/db2/interfaceIModifyProcessInstanceCommandStep2.html#a89d2f1ff2f16b051743b433990113b1a">More...</a><br /></td></tr>
<tr class="separator:a89d2f1ff2f16b051743b433990113b1a inherit pub_methods_interfaceIModifyProcessInstanceCommandStep2"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p >Third command step, to optionally add variables to the element which should be activated. </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="afc5466763091e86797d2d4b7d91b1a39" name="afc5466763091e86797d2d4b7d91b1a39"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afc5466763091e86797d2d4b7d91b1a39">&#9670;&#160;</a></span>WithVariables() <span class="overload">[1/2]</span></h2>

<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="../../d0/d4b/interfaceIModifyProcessInstanceCommandStep3.html">IModifyProcessInstanceCommandStep3</a> IModifyProcessInstanceCommandStep3.WithVariables </td>
<td>(</td>
<td class="paramtype">string&#160;</td>
<td class="paramname"><em>variables</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">

<p>Create a variable instruction for the element that's getting activated. These variables will be created in the global scope of the process instance. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">variables</td><td>The variables JSON document as String.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The builder for this command.</dd></dl>

</div>
</div>
<a id="a77b27701c3be61c204cb02d496636cbe" name="a77b27701c3be61c204cb02d496636cbe"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a77b27701c3be61c204cb02d496636cbe">&#9670;&#160;</a></span>WithVariables() <span class="overload">[2/2]</span></h2>

<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="../../d0/d4b/interfaceIModifyProcessInstanceCommandStep3.html">IModifyProcessInstanceCommandStep3</a> IModifyProcessInstanceCommandStep3.WithVariables </td>
<td>(</td>
<td class="paramtype">string&#160;</td>
<td class="paramname"><em>variables</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">string&#160;</td>
<td class="paramname"><em>scopeId</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">

<p>Create a variable instruction for the element that's getting activated. These variables will be created in the scope of the passed element. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">variables</td><td>The variables JSON document as String.</td></tr>
<tr><td class="paramname">scopeId</td><td>The id of the element in which scope the variables should be created.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The builder for this command.</dd></dl>

</div>
</div>
<hr/>The documentation for this interface was generated from the following file:<ul>
<li>Client/Api/Commands/IModifyProcessInstanceCommandStep1.cs</li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="../../d0/d4b/interfaceIModifyProcessInstanceCommandStep3.html">IModifyProcessInstanceCommandStep3</a></li>
<li class="footer">Generated on Thu Feb 1 2024 15:47:54 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.5 </li>
</ul>
</div>
</body>
</html>
5 changes: 5 additions & 0 deletions docs/d0/d4b/interfaceIModifyProcessInstanceCommandStep3.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
var interfaceIModifyProcessInstanceCommandStep3 =
[
[ "WithVariables", "d0/d4b/interfaceIModifyProcessInstanceCommandStep3.html#afc5466763091e86797d2d4b7d91b1a39", null ],
[ "WithVariables", "d0/d4b/interfaceIModifyProcessInstanceCommandStep3.html#a77b27701c3be61c204cb02d496636cbe", null ]
];
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading

0 comments on commit 955227f

Please sign in to comment.