Skip to content

Commit 9dc489e

Browse files
Update documentation after commit 962c09d
1 parent 962c09d commit 9dc489e

File tree

4 files changed

+47
-11
lines changed

4 files changed

+47
-11
lines changed

docs/api/MASES.KafkaBridge.Const.html

Lines changed: 36 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -113,20 +113,50 @@ <h5 id="MASES_KafkaBridge_Const_syntax">Syntax</h5>
113113
</div>
114114
<h3 id="fields">Fields
115115
</h3>
116+
<span class="small pull-right mobile-hide">
117+
<span class="divider">|</span>
118+
<a href="https://github.com/masesgroup/KafkaBridge/new/master/apiSpec/new?filename=MASES_KafkaBridge_Const_AssemblyLocation.md&amp;value=---%0Auid%3A%20MASES.KafkaBridge.Const.AssemblyLocation%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
119+
</span>
120+
<span class="small pull-right mobile-hide">
121+
<a href="https://github.com/masesgroup/KafkaBridge/blob/master/src/net/KafkaBridge/InternalConst.cs/#L41">View Source</a>
122+
</span>
123+
<h4 id="MASES_KafkaBridge_Const_AssemblyLocation" data-uid="MASES.KafkaBridge.Const.AssemblyLocation">AssemblyLocation</h4>
124+
<div class="markdown level1 summary"><p>The location of this assembly</p>
125+
</div>
126+
<div class="markdown level1 conceptual"></div>
127+
<h5 class="decalaration">Declaration</h5>
128+
<div class="codewrapper">
129+
<pre><code class="lang-csharp hljs">public static readonly string AssemblyLocation</code></pre>
130+
</div>
131+
<h5 class="fieldValue">Field Value</h5>
132+
<table class="table table-bordered table-striped table-condensed">
133+
<thead>
134+
<tr>
135+
<th>Type</th>
136+
<th>Description</th>
137+
</tr>
138+
</thead>
139+
<tbody>
140+
<tr>
141+
<td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.string">String</a></td>
142+
<td></td>
143+
</tr>
144+
</tbody>
145+
</table>
116146
<span class="small pull-right mobile-hide">
117147
<span class="divider">|</span>
118148
<a href="https://github.com/masesgroup/KafkaBridge/new/master/apiSpec/new?filename=MASES_KafkaBridge_Const_DefaultLog4JPath.md&amp;value=---%0Auid%3A%20MASES.KafkaBridge.Const.DefaultLog4JPath%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
119149
</span>
120150
<span class="small pull-right mobile-hide">
121-
<a href="https://github.com/masesgroup/KafkaBridge/blob/master/src/net/KafkaBridge/InternalConst.cs/#L48">View Source</a>
151+
<a href="https://github.com/masesgroup/KafkaBridge/blob/master/src/net/KafkaBridge/InternalConst.cs/#L53">View Source</a>
122152
</span>
123153
<h4 id="MASES_KafkaBridge_Const_DefaultLog4JPath" data-uid="MASES.KafkaBridge.Const.DefaultLog4JPath">DefaultLog4JPath</h4>
124154
<div class="markdown level1 summary"><p>Default log4j path, i.e. consider installation within bin folder</p>
125155
</div>
126156
<div class="markdown level1 conceptual"></div>
127157
<h5 class="decalaration">Declaration</h5>
128158
<div class="codewrapper">
129-
<pre><code class="lang-csharp hljs">public const string DefaultLog4JPath = &quot;./config/log4j.properties&quot;</code></pre>
159+
<pre><code class="lang-csharp hljs">public static readonly string DefaultLog4JPath</code></pre>
130160
</div>
131161
<h5 class="fieldValue">Field Value</h5>
132162
<table class="table table-bordered table-striped table-condensed">
@@ -148,15 +178,15 @@ <h5 class="fieldValue">Field Value</h5>
148178
<a href="https://github.com/masesgroup/KafkaBridge/new/master/apiSpec/new?filename=MASES_KafkaBridge_Const_DefaultRootPath.md&amp;value=---%0Auid%3A%20MASES.KafkaBridge.Const.DefaultRootPath%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
149179
</span>
150180
<span class="small pull-right mobile-hide">
151-
<a href="https://github.com/masesgroup/KafkaBridge/blob/master/src/net/KafkaBridge/InternalConst.cs/#L44">View Source</a>
181+
<a href="https://github.com/masesgroup/KafkaBridge/blob/master/src/net/KafkaBridge/InternalConst.cs/#L49">View Source</a>
152182
</span>
153183
<h4 id="MASES_KafkaBridge_Const_DefaultRootPath" data-uid="MASES.KafkaBridge.Const.DefaultRootPath">DefaultRootPath</h4>
154184
<div class="markdown level1 summary"><p>Default root path, i.e. consider installation within bin folder</p>
155185
</div>
156186
<div class="markdown level1 conceptual"></div>
157187
<h5 class="decalaration">Declaration</h5>
158188
<div class="codewrapper">
159-
<pre><code class="lang-csharp hljs">public const string DefaultRootPath = &quot;./jars&quot;</code></pre>
189+
<pre><code class="lang-csharp hljs">public static readonly string DefaultRootPath</code></pre>
160190
</div>
161191
<h5 class="fieldValue">Field Value</h5>
162192
<table class="table table-bordered table-striped table-condensed">
@@ -178,7 +208,7 @@ <h5 class="fieldValue">Field Value</h5>
178208
<a href="https://github.com/masesgroup/KafkaBridge/new/master/apiSpec/new?filename=MASES_KafkaBridge_Const_DefaultScalaVersion.md&amp;value=---%0Auid%3A%20MASES.KafkaBridge.Const.DefaultScalaVersion%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
179209
</span>
180210
<span class="small pull-right mobile-hide">
181-
<a href="https://github.com/masesgroup/KafkaBridge/blob/master/src/net/KafkaBridge/InternalConst.cs/#L40">View Source</a>
211+
<a href="https://github.com/masesgroup/KafkaBridge/blob/master/src/net/KafkaBridge/InternalConst.cs/#L45">View Source</a>
182212
</span>
183213
<h4 id="MASES_KafkaBridge_Const_DefaultScalaVersion" data-uid="MASES.KafkaBridge.Const.DefaultScalaVersion">DefaultScalaVersion</h4>
184214
<div class="markdown level1 summary"><p>Default Scala version</p>
@@ -214,7 +244,7 @@ <h5 class="fieldValue">Field Value</h5>
214244
<a href="https://github.com/masesgroup/KafkaBridge/new/master/apiSpec/new?filename=MASES_KafkaBridge_Const.md&amp;value=---%0Auid%3A%20MASES.KafkaBridge.Const%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A" class="contribution-link">Improve this Doc</a>
215245
</li>
216246
<li>
217-
<a href="https://github.com/masesgroup/KafkaBridge/blob/master/src/net/KafkaBridge/InternalConst.cs/#L35" class="contribution-link">View Source</a>
247+
<a href="https://github.com/masesgroup/KafkaBridge/blob/master/src/net/KafkaBridge/InternalConst.cs/#L36" class="contribution-link">View Source</a>
218248
</li>
219249
</ul>
220250
</div>

docs/api/MASES.KafkaBridge.KafkaBridgeCore.html

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -243,7 +243,7 @@ <h5 class="propertyValue">Property Value</h5>
243243
<a href="https://github.com/masesgroup/KafkaBridge/new/master/apiSpec/new?filename=MASES_KafkaBridge_KafkaBridgeCore_ClassPath.md&amp;value=---%0Auid%3A%20MASES.KafkaBridge.KafkaBridgeCore.ClassPath%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
244244
</span>
245245
<span class="small pull-right mobile-hide">
246-
<a href="https://github.com/masesgroup/KafkaBridge/blob/master/src/net/KafkaBridge/KafkaBridgeCore.cs/#L344">View Source</a>
246+
<a href="https://github.com/masesgroup/KafkaBridge/blob/master/src/net/KafkaBridge/KafkaBridgeCore.cs/#L343">View Source</a>
247247
</span>
248248
<a id="MASES_KafkaBridge_KafkaBridgeCore_ClassPath_" data-uid="MASES.KafkaBridge.KafkaBridgeCore.ClassPath*"></a>
249249
<h4 id="MASES_KafkaBridge_KafkaBridgeCore_ClassPath" data-uid="MASES.KafkaBridge.KafkaBridgeCore.ClassPath">ClassPath</h4>
@@ -678,7 +678,7 @@ <h5 class="propertyValue">Property Value</h5>
678678
<a href="https://github.com/masesgroup/KafkaBridge/new/master/apiSpec/new?filename=MASES_KafkaBridge_KafkaBridgeCore_DynJVM.md&amp;value=---%0Auid%3A%20MASES.KafkaBridge.KafkaBridgeCore.DynJVM%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
679679
</span>
680680
<span class="small pull-right mobile-hide">
681-
<a href="https://github.com/masesgroup/KafkaBridge/blob/master/src/net/KafkaBridge/KafkaBridgeCore.cs/#L346">View Source</a>
681+
<a href="https://github.com/masesgroup/KafkaBridge/blob/master/src/net/KafkaBridge/KafkaBridgeCore.cs/#L345">View Source</a>
682682
</span>
683683
<a id="MASES_KafkaBridge_KafkaBridgeCore_DynJVM_" data-uid="MASES.KafkaBridge.KafkaBridgeCore.DynJVM*"></a>
684684
<h4 id="MASES_KafkaBridge_KafkaBridgeCore_DynJVM" data-uid="MASES.KafkaBridge.KafkaBridgeCore.DynJVM">DynJVM</h4>
@@ -1049,7 +1049,7 @@ <h5 class="propertyValue">Property Value</h5>
10491049
<a href="https://github.com/masesgroup/KafkaBridge/new/master/apiSpec/new?filename=MASES_KafkaBridge_KafkaBridgeCore_JVM.md&amp;value=---%0Auid%3A%20MASES.KafkaBridge.KafkaBridgeCore.JVM%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
10501050
</span>
10511051
<span class="small pull-right mobile-hide">
1052-
<a href="https://github.com/masesgroup/KafkaBridge/blob/master/src/net/KafkaBridge/KafkaBridgeCore.cs/#L348">View Source</a>
1052+
<a href="https://github.com/masesgroup/KafkaBridge/blob/master/src/net/KafkaBridge/KafkaBridgeCore.cs/#L347">View Source</a>
10531053
</span>
10541054
<a id="MASES_KafkaBridge_KafkaBridgeCore_JVM_" data-uid="MASES.KafkaBridge.KafkaBridgeCore.JVM*"></a>
10551055
<h4 id="MASES_KafkaBridge_KafkaBridgeCore_JVM" data-uid="MASES.KafkaBridge.KafkaBridgeCore.JVM">JVM</h4>

docs/manifest.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -669,7 +669,7 @@
669669
"output": {
670670
".html": {
671671
"relative_path": "api/MASES.KafkaBridge.Const.html",
672-
"hash": "Ae0tBw/wdbQfLeUYyVnD/huMUgokLTW66sVi4r/hOto="
672+
"hash": "Fcjpc02jPsjOvCzSj6tUhL8W6OU5ElX0u5ccUUQGfdk="
673673
}
674674
},
675675
"is_incremental": false,
@@ -861,7 +861,7 @@
861861
"output": {
862862
".html": {
863863
"relative_path": "api/MASES.KafkaBridge.KafkaBridgeCore.html",
864-
"hash": "L4He6l/6usFuq1Eh9s3Qw88sZFn2Kw75s7RNwzMetUI="
864+
"hash": "JZoL6G5ifpPXly6abZECFSqs5EKR35EfAI4NUPu6Me4="
865865
}
866866
},
867867
"is_incremental": false,

docs/xrefmap.yml

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3221,6 +3221,12 @@ references:
32213221
commentId: T:MASES.KafkaBridge.Const
32223222
fullName: MASES.KafkaBridge.Const
32233223
nameWithType: Const
3224+
- uid: MASES.KafkaBridge.Const.AssemblyLocation
3225+
name: AssemblyLocation
3226+
href: api/MASES.KafkaBridge.Const.html#MASES_KafkaBridge_Const_AssemblyLocation
3227+
commentId: F:MASES.KafkaBridge.Const.AssemblyLocation
3228+
fullName: MASES.KafkaBridge.Const.AssemblyLocation
3229+
nameWithType: Const.AssemblyLocation
32243230
- uid: MASES.KafkaBridge.Const.DefaultLog4JPath
32253231
name: DefaultLog4JPath
32263232
href: api/MASES.KafkaBridge.Const.html#MASES_KafkaBridge_Const_DefaultLog4JPath

0 commit comments

Comments
 (0)