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.

Sign up for GitHub

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

Jump to bottom

Update generated documentation #230

Open
wants to merge 1 commit into
base: gh-pages
Choose a base branch
from
Open

Update generated documentation #230

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
  •  
  •  
  •  
55 changes: 28 additions & 27 deletions ...asks/Sdl.ProjectAutomation.AutomaticTasks.AbstractFileContentProcessingAutomaticTask.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -91,34 +91,34 @@ <h1 id="Sdl_ProjectAutomation_AutomaticTasks_AbstractFileContentProcessingAutoma
<div class="markdown level0 conceptual"></div>
<div class="inheritance">
<h5>Inheritance</h5>
<div class="level0"><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a></div>
<div class="level0"><span class="xref">System.Object</span></div>
<div class="level1"><span class="xref">AbstractFileContentProcessingAutomaticTask</span></div>
</div>
<div class="inheritedMembers">
<h5>Inherited Members</h5>
<div>
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.tostring">object.ToString()</a>
<span class="xref">System.Object.ToString()</span>
</div>
<div>
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)">object.Equals(object)</a>
<span class="xref">System.Object.Equals(System.Object)</span>
</div>
<div>
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)">object.Equals(object, object)</a>
<span class="xref">System.Object.Equals(System.Object, System.Object)</span>
</div>
<div>
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.referenceequals">object.ReferenceEquals(object, object)</a>
<span class="xref">System.Object.ReferenceEquals(System.Object, System.Object)</span>
</div>
<div>
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.gethashcode">object.GetHashCode()</a>
<span class="xref">System.Object.GetHashCode()</span>
</div>
<div>
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.gettype">object.GetType()</a>
<span class="xref">System.Object.GetType()</span>
</div>
<div>
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone">object.MemberwiseClone()</a>
<span class="xref">System.Object.MemberwiseClone()</span>
</div>
</div>
<h6><strong>Namespace</strong>: <span class="xref">Sdl</span><span class="xref">Sdl.ProjectAutomation</span><a class="xref" href="Sdl.ProjectAutomation.AutomaticTasks.html">AutomaticTasks</a></h6>
<h6><strong>Namespace</strong>: <a class="xref" href="Sdl.ProjectAutomation.AutomaticTasks.html">Sdl.ProjectAutomation.AutomaticTasks</a></h6>
<h6><strong>Assembly</strong>: Sdl.ProjectAutomation.AutomaticTasks.dll</h6>
<h5 id="Sdl_ProjectAutomation_AutomaticTasks_AbstractFileContentProcessingAutomaticTask_syntax">Syntax</h5>
<div class="codewrapper">
Expand Down Expand Up @@ -185,7 +185,7 @@ <h5 class="propertyValue">Property Value</h5>
</thead>
<tbody>
<tr>
<td><a class="xref" href="../projectautomation/Sdl.ProjectAutomation.Core.ProjectFile.html">ProjectFile</a></td>
<td><a class="xref" href="../projectautomation/Sdl.ProjectAutomation.Core.ProjectFile.html">ProjectFile</a>[]</td>
<td></td>
</tr>
</tbody>
Expand All @@ -211,7 +211,7 @@ <h5 class="propertyValue">Property Value</h5>
</thead>
<tbody>
<tr>
<td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></td>
<td><span class="xref">System.String</span></td>
<td></td>
</tr>
</tbody>
Expand All @@ -221,7 +221,7 @@ <h3 id="methods">Methods


<a id="Sdl_ProjectAutomation_AutomaticTasks_AbstractFileContentProcessingAutomaticTask_Cancel_" data-uid="Sdl.ProjectAutomation.AutomaticTasks.AbstractFileContentProcessingAutomaticTask.Cancel*"></a>
<h4 id="Sdl_ProjectAutomation_AutomaticTasks_AbstractFileContentProcessingAutomaticTask_Cancel_System_Boolean_" data-uid="Sdl.ProjectAutomation.AutomaticTasks.AbstractFileContentProcessingAutomaticTask.Cancel(System.Boolean)">Cancel(bool)</h4>
<h4 id="Sdl_ProjectAutomation_AutomaticTasks_AbstractFileContentProcessingAutomaticTask_Cancel_System_Boolean_" data-uid="Sdl.ProjectAutomation.AutomaticTasks.AbstractFileContentProcessingAutomaticTask.Cancel(System.Boolean)">Cancel(Boolean)</h4>
<div class="markdown level1 summary"><p>Called when user request cancel manually.</p>
</div>
<div class="markdown level1 conceptual"></div>
Expand All @@ -240,7 +240,7 @@ <h5 class="parameters">Parameters</h5>
</thead>
<tbody>
<tr>
<td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></td>
<td><span class="xref">System.Boolean</span></td>
<td><span class="parametername">doRollback</span></td>
<td></td>
</tr>
Expand Down Expand Up @@ -270,7 +270,7 @@ <h5 class="parameters">Parameters</h5>
<tr>
<td><a class="xref" href="../projectautomation/Sdl.ProjectAutomation.Core.ProjectFile.html">ProjectFile</a></td>
<td><span class="parametername">projectFile</span></td>
<td><p>The file to processed in this task.</p>
<td><p>The file to processed in this task. </p>
</td>
</tr>
<tr>
Expand All @@ -284,10 +284,10 @@ <h5 class="parameters">Parameters</h5>


<a id="Sdl_ProjectAutomation_AutomaticTasks_AbstractFileContentProcessingAutomaticTask_CreateReport_" data-uid="Sdl.ProjectAutomation.AutomaticTasks.AbstractFileContentProcessingAutomaticTask.CreateReport*"></a>
<h4 id="Sdl_ProjectAutomation_AutomaticTasks_AbstractFileContentProcessingAutomaticTask_CreateReport_System_String_System_String_System_String_" data-uid="Sdl.ProjectAutomation.AutomaticTasks.AbstractFileContentProcessingAutomaticTask.CreateReport(System.String,System.String,System.String)">CreateReport(string, string, string)</h4>
<h4 id="Sdl_ProjectAutomation_AutomaticTasks_AbstractFileContentProcessingAutomaticTask_CreateReport_System_String_System_String_System_String_" data-uid="Sdl.ProjectAutomation.AutomaticTasks.AbstractFileContentProcessingAutomaticTask.CreateReport(System.String,System.String,System.String)">CreateReport(String, String, String)</h4>
<div class="markdown level1 summary"><p>Creates a report for this task. Generally the report data is created in xml format. The xml data will be provided to function as the data parameter.
When a report is created the xml data will be stored as a xml file residing normally under the project/Reports folder. To render the report properly
in the report view, a xslt file should be present in the task implementation project as embeded resource. The xlst file must have extension .xsl.</p>
in the report view, a xslt file should be present in the task implementation project as embeded resource. The xlst file must have extension .xsl. </p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
Expand All @@ -305,19 +305,19 @@ <h5 class="parameters">Parameters</h5>
</thead>
<tbody>
<tr>
<td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></td>
<td><span class="xref">System.String</span></td>
<td><span class="parametername">name</span></td>
<td><p>The name of the report.</p>
</td>
</tr>
<tr>
<td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></td>
<td><span class="xref">System.String</span></td>
<td><span class="parametername">description</span></td>
<td><p>The description of this Report.</p>
</td>
</tr>
<tr>
<td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></td>
<td><span class="xref">System.String</span></td>
<td><span class="parametername">data</span></td>
<td><p>The xml data of this report.</p>
</td>
Expand All @@ -327,10 +327,10 @@ <h5 class="parameters">Parameters</h5>


<a id="Sdl_ProjectAutomation_AutomaticTasks_AbstractFileContentProcessingAutomaticTask_CreateReport_" data-uid="Sdl.ProjectAutomation.AutomaticTasks.AbstractFileContentProcessingAutomaticTask.CreateReport*"></a>
<h4 id="Sdl_ProjectAutomation_AutomaticTasks_AbstractFileContentProcessingAutomaticTask_CreateReport_System_String_System_String_System_String_Sdl_ProjectAutomation_AutomaticTasks_LanguageDirection_" data-uid="Sdl.ProjectAutomation.AutomaticTasks.AbstractFileContentProcessingAutomaticTask.CreateReport(System.String,System.String,System.String,Sdl.ProjectAutomation.AutomaticTasks.LanguageDirection)">CreateReport(string, string, string, LanguageDirection)</h4>
<h4 id="Sdl_ProjectAutomation_AutomaticTasks_AbstractFileContentProcessingAutomaticTask_CreateReport_System_String_System_String_System_String_Sdl_ProjectAutomation_AutomaticTasks_LanguageDirection_" data-uid="Sdl.ProjectAutomation.AutomaticTasks.AbstractFileContentProcessingAutomaticTask.CreateReport(System.String,System.String,System.String,Sdl.ProjectAutomation.AutomaticTasks.LanguageDirection)">CreateReport(String, String, String, LanguageDirection)</h4>
<div class="markdown level1 summary"><p>Creates a report with a specified language for this task. Generally the report data is created in xml format. The xml data will be provided to function as the data parameter.
When a report is created the xml data will be stored as a xml file residing normally under the project/Reports folder. To render the report properly
in the report view, a xslt file should be present in the task implementation project as embeded resource. The xlst file must have extension .xsl.</p>
in the report view, a xslt file should be present in the task implementation project as embeded resource. The xlst file must have extension .xsl. </p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
Expand All @@ -348,19 +348,19 @@ <h5 class="parameters">Parameters</h5>
</thead>
<tbody>
<tr>
<td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></td>
<td><span class="xref">System.String</span></td>
<td><span class="parametername">name</span></td>
<td><p>The name of the report.</p>
</td>
</tr>
<tr>
<td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></td>
<td><span class="xref">System.String</span></td>
<td><span class="parametername">description</span></td>
<td><p>The description of this Report.</p>
</td>
</tr>
<tr>
<td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></td>
<td><span class="xref">System.String</span></td>
<td><span class="parametername">data</span></td>
<td><p>The xml data of this report.</p>
</td>
Expand All @@ -382,7 +382,8 @@ <h4 id="Sdl_ProjectAutomation_AutomaticTasks_AbstractFileContentProcessingAutoma
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">protected TSettings GetSetting&lt;TSettings&gt;() where TSettings : ISettingsGroup, new()</code></pre>
<pre><code class="lang-csharp hljs">protected TSettings GetSetting&lt;TSettings&gt;()
where TSettings : ISettingsGroup, new()</code></pre>
</div>
<h5 class="returns">Returns</h5>
<table class="table table-bordered table-striped table-condensed">
Expand Down Expand Up @@ -503,7 +504,7 @@ <h5 class="returns">Returns</h5>
</thead>
<tbody>
<tr>
<td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></td>
<td><span class="xref">System.Boolean</span></td>
<td><p>Returns true to indicate the file is updated. By default it returns false.</p>
</td>
</tr>
Expand Down Expand Up @@ -559,7 +560,7 @@ <h5 class="returns">Returns</h5>
</thead>
<tbody>
<tr>
<td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></td>
<td><span class="xref">System.Boolean</span></td>
<td></td>
</tr>
</tbody>
Expand Down
34 changes: 17 additions & 17 deletions api/batchtasks/Sdl.ProjectAutomation.AutomaticTasks.AbstractFileLevelAutomaticTask.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -91,34 +91,34 @@ <h1 id="Sdl_ProjectAutomation_AutomaticTasks_AbstractFileLevelAutomaticTask" dat
<div class="markdown level0 conceptual"></div>
<div class="inheritance">
<h5>Inheritance</h5>
<div class="level0"><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a></div>
<div class="level0"><span class="xref">System.Object</span></div>
<div class="level1"><span class="xref">AbstractFileLevelAutomaticTask</span></div>
</div>
<div class="inheritedMembers">
<h5>Inherited Members</h5>
<div>
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.tostring">object.ToString()</a>
<span class="xref">System.Object.ToString()</span>
</div>
<div>
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)">object.Equals(object)</a>
<span class="xref">System.Object.Equals(System.Object)</span>
</div>
<div>
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)">object.Equals(object, object)</a>
<span class="xref">System.Object.Equals(System.Object, System.Object)</span>
</div>
<div>
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.referenceequals">object.ReferenceEquals(object, object)</a>
<span class="xref">System.Object.ReferenceEquals(System.Object, System.Object)</span>
</div>
<div>
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.gethashcode">object.GetHashCode()</a>
<span class="xref">System.Object.GetHashCode()</span>
</div>
<div>
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.gettype">object.GetType()</a>
<span class="xref">System.Object.GetType()</span>
</div>
<div>
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone">object.MemberwiseClone()</a>
<span class="xref">System.Object.MemberwiseClone()</span>
</div>
</div>
<h6><strong>Namespace</strong>: <span class="xref">Sdl</span><span class="xref">Sdl.ProjectAutomation</span><a class="xref" href="Sdl.ProjectAutomation.AutomaticTasks.html">AutomaticTasks</a></h6>
<h6><strong>Namespace</strong>: <a class="xref" href="Sdl.ProjectAutomation.AutomaticTasks.html">Sdl.ProjectAutomation.AutomaticTasks</a></h6>
<h6><strong>Assembly</strong>: Sdl.ProjectAutomation.AutomaticTasks.dll</h6>
<h5 id="Sdl_ProjectAutomation_AutomaticTasks_AbstractFileLevelAutomaticTask_syntax">Syntax</h5>
<div class="codewrapper">
Expand Down Expand Up @@ -159,7 +159,7 @@ <h5 class="propertyValue">Property Value</h5>
</thead>
<tbody>
<tr>
<td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></td>
<td><span class="xref">System.Boolean</span></td>
<td></td>
</tr>
</tbody>
Expand Down Expand Up @@ -212,7 +212,7 @@ <h5 class="propertyValue">Property Value</h5>
</thead>
<tbody>
<tr>
<td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></td>
<td><span class="xref">System.Boolean</span></td>
<td></td>
</tr>
</tbody>
Expand All @@ -238,7 +238,7 @@ <h5 class="propertyValue">Property Value</h5>
</thead>
<tbody>
<tr>
<td><a class="xref" href="../projectautomation/Sdl.ProjectAutomation.Core.ProjectFile.html">ProjectFile</a></td>
<td><a class="xref" href="../projectautomation/Sdl.ProjectAutomation.Core.ProjectFile.html">ProjectFile</a>[]</td>
<td></td>
</tr>
</tbody>
Expand All @@ -248,7 +248,7 @@ <h3 id="methods">Methods


<a id="Sdl_ProjectAutomation_AutomaticTasks_AbstractFileLevelAutomaticTask_Cancel_" data-uid="Sdl.ProjectAutomation.AutomaticTasks.AbstractFileLevelAutomaticTask.Cancel*"></a>
<h4 id="Sdl_ProjectAutomation_AutomaticTasks_AbstractFileLevelAutomaticTask_Cancel_System_Boolean_" data-uid="Sdl.ProjectAutomation.AutomaticTasks.AbstractFileLevelAutomaticTask.Cancel(System.Boolean)">Cancel(bool)</h4>
<h4 id="Sdl_ProjectAutomation_AutomaticTasks_AbstractFileLevelAutomaticTask_Cancel_System_Boolean_" data-uid="Sdl.ProjectAutomation.AutomaticTasks.AbstractFileLevelAutomaticTask.Cancel(System.Boolean)">Cancel(Boolean)</h4>
<div class="markdown level1 summary"><p>Called when the task execution is request to cancel.</p>
</div>
<div class="markdown level1 conceptual"></div>
Expand All @@ -267,7 +267,7 @@ <h5 class="parameters">Parameters</h5>
</thead>
<tbody>
<tr>
<td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></td>
<td><span class="xref">System.Boolean</span></td>
<td><span class="parametername">doRollback</span></td>
<td></td>
</tr>
Expand Down Expand Up @@ -368,7 +368,7 @@ <h5 class="decalaration">Declaration</h5>


<a id="Sdl_ProjectAutomation_AutomaticTasks_AbstractFileLevelAutomaticTask_UploadFile_" data-uid="Sdl.ProjectAutomation.AutomaticTasks.AbstractFileLevelAutomaticTask.UploadFile*"></a>
<h4 id="Sdl_ProjectAutomation_AutomaticTasks_AbstractFileLevelAutomaticTask_UploadFile_Sdl_ProjectAutomation_Core_ProjectFile_System_String_" data-uid="Sdl.ProjectAutomation.AutomaticTasks.AbstractFileLevelAutomaticTask.UploadFile(Sdl.ProjectAutomation.Core.ProjectFile,System.String)">UploadFile(ProjectFile, string)</h4>
<h4 id="Sdl_ProjectAutomation_AutomaticTasks_AbstractFileLevelAutomaticTask_UploadFile_Sdl_ProjectAutomation_Core_ProjectFile_System_String_" data-uid="Sdl.ProjectAutomation.AutomaticTasks.AbstractFileLevelAutomaticTask.UploadFile(Sdl.ProjectAutomation.Core.ProjectFile,System.String)">UploadFile(ProjectFile, String)</h4>
<div class="markdown level1 summary"><p>Uploads the file for the new version generated.</p>
</div>
<div class="markdown level1 conceptual"></div>
Expand All @@ -393,7 +393,7 @@ <h5 class="parameters">Parameters</h5>
</td>
</tr>
<tr>
<td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></td>
<td><span class="xref">System.String</span></td>
<td><span class="parametername">localFilePath</span></td>
<td><p>The local path of the file.</p>
</td>
Expand Down Expand Up @@ -422,7 +422,7 @@ <h5 class="eventType">Event Type</h5>
</thead>
<tbody>
<tr>
<td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.eventhandler-1">EventHandler</a><a class="xref" href="Sdl.ProjectAutomation.AutomaticTasks.TaskProgressEventArgs.html">TaskProgressEventArgs</a></td>
<td><span class="xref">System.EventHandler</span>&lt;<a class="xref" href="Sdl.ProjectAutomation.AutomaticTasks.TaskProgressEventArgs.html">TaskProgressEventArgs</a>&gt;</td>
<td></td>
</tr>
</tbody>
Expand Down
Loading
Loading