Skip to content

Commit

Permalink
fix some problems of documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
Huaxing YUAN authored and Huaxing YUAN committed Jan 7, 2025
1 parent 6811674 commit 9be1136
Show file tree
Hide file tree
Showing 25 changed files with 556 additions and 546 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -471,7 +471,8 @@ <h3 id="methods">Methods

<a id="AxaFrance_WebEngine_MobileApp_AppElementDescription_ApplyAttribute_" data-uid="AxaFrance.WebEngine.MobileApp.AppElementDescription.ApplyAttribute*"></a>
<h4 id="AxaFrance_WebEngine_MobileApp_AppElementDescription_ApplyAttribute_AxaFrance_WebEngine_Web_FindsByAttribute_" data-uid="AxaFrance.WebEngine.MobileApp.AppElementDescription.ApplyAttribute(AxaFrance.WebEngine.Web.FindsByAttribute)">ApplyAttribute(FindsByAttribute)</h4>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Applies the locator defined in <a class="xref" href="AxaFrance.WebEngine.Web.FindsByAttribute.html">FindsByAttribute</a>. this function is called automatically before <a class="xref" href="AxaFrance.WebEngine.Web.ElementDescription.html#AxaFrance_WebEngine_Web_ElementDescription_InternalFindElements">InternalFindElements()</a></p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
Expand Down Expand Up @@ -500,7 +501,8 @@ <h5 class="overrides">Overrides</h5>

<a id="AxaFrance_WebEngine_MobileApp_AppElementDescription_InternalFindElement_" data-uid="AxaFrance.WebEngine.MobileApp.AppElementDescription.InternalFindElement*"></a>
<h4 id="AxaFrance_WebEngine_MobileApp_AppElementDescription_InternalFindElement" data-uid="AxaFrance.WebEngine.MobileApp.AppElementDescription.InternalFindElement">InternalFindElement()</h4>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Implemente element identifying algorithm, without the need of object synchronization.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
Expand All @@ -517,7 +519,8 @@ <h5 class="returns">Returns</h5>
<tbody>
<tr>
<td><span class="xref">OpenQA.Selenium.IWebElement</span></td>
<td></td>
<td><p>Identified test object.</p>
</td>
</tr>
</tbody>
</table>
Expand All @@ -527,7 +530,8 @@ <h5 class="overrides">Overrides</h5>

<a id="AxaFrance_WebEngine_MobileApp_AppElementDescription_InternalFindElements_" data-uid="AxaFrance.WebEngine.MobileApp.AppElementDescription.InternalFindElements*"></a>
<h4 id="AxaFrance_WebEngine_MobileApp_AppElementDescription_InternalFindElements" data-uid="AxaFrance.WebEngine.MobileApp.AppElementDescription.InternalFindElements">InternalFindElements()</h4>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Implemente element identifying algorithm, without the need of object synchronization.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
Expand All @@ -544,7 +548,8 @@ <h5 class="returns">Returns</h5>
<tbody>
<tr>
<td><span class="xref">System.Collections.Generic.IReadOnlyCollection</span>&lt;<span class="xref">OpenQA.Selenium.IWebElement</span>&gt;</td>
<td></td>
<td><p>Identified test objects</p>
</td>
</tr>
</tbody>
</table>
Expand All @@ -554,7 +559,8 @@ <h5 class="overrides">Overrides</h5>

<a id="AxaFrance_WebEngine_MobileApp_AppElementDescription_InternalGetScreenshot_" data-uid="AxaFrance.WebEngine.MobileApp.AppElementDescription.InternalGetScreenshot*"></a>
<h4 id="AxaFrance_WebEngine_MobileApp_AppElementDescription_InternalGetScreenshot" data-uid="AxaFrance.WebEngine.MobileApp.AppElementDescription.InternalGetScreenshot">InternalGetScreenshot()</h4>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Implemente screenshot generation for the current specific element</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
Expand All @@ -571,7 +577,8 @@ <h5 class="returns">Returns</h5>
<tbody>
<tr>
<td><span class="xref">System.Byte</span>[]</td>
<td></td>
<td><p>The screenshot image in RAW Binary data format.</p>
</td>
</tr>
</tbody>
</table>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -385,7 +385,8 @@ <h5 class="decalaration">Declaration</h5>

<a id="AxaFrance_WebEngine_MobileApp_SharedActionApp_Screenshot_" data-uid="AxaFrance.WebEngine.MobileApp.SharedActionApp.Screenshot*"></a>
<h4 id="AxaFrance_WebEngine_MobileApp_SharedActionApp_Screenshot_System_String_" data-uid="AxaFrance.WebEngine.MobileApp.SharedActionApp.Screenshot(System.String)">Screenshot(String)</h4>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Provide screen-shot in the report</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
Expand Down
9 changes: 6 additions & 3 deletions docs/api_net/AxaFrance.WebEngine.MobileApp.TestCaseApp.html
Original file line number Diff line number Diff line change
Expand Up @@ -136,7 +136,8 @@ <h3 id="methods">Methods

<a id="AxaFrance_WebEngine_MobileApp_TestCaseApp_Cleanup_" data-uid="AxaFrance.WebEngine.MobileApp.TestCaseApp.Cleanup*"></a>
<h4 id="AxaFrance_WebEngine_MobileApp_TestCaseApp_Cleanup" data-uid="AxaFrance.WebEngine.MobileApp.TestCaseApp.Cleanup">Cleanup()</h4>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>cleanup the context of the test case</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
Expand All @@ -153,7 +154,8 @@ <h5 class="returns">Returns</h5>
<tbody>
<tr>
<td><span class="xref">System.String</span></td>
<td></td>
<td><p>Detailed information about the clean up</p>
</td>
</tr>
</tbody>
</table>
Expand All @@ -163,7 +165,8 @@ <h5 class="overrides">Overrides</h5>

<a id="AxaFrance_WebEngine_MobileApp_TestCaseApp_Initialize_" data-uid="AxaFrance.WebEngine.MobileApp.TestCaseApp.Initialize*"></a>
<h4 id="AxaFrance_WebEngine_MobileApp_TestCaseApp_Initialize" data-uid="AxaFrance.WebEngine.MobileApp.TestCaseApp.Initialize">Initialize()</h4>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Initialize the context of the test case</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
Expand Down
6 changes: 3 additions & 3 deletions docs/api_net/AxaFrance.WebEngine.Web.TestCaseWeb.html
Original file line number Diff line number Diff line change
Expand Up @@ -186,14 +186,14 @@ <h5 class="propertyValue">Property Value</h5>
</table>


<a id="AxaFrance_WebEngine_Web_TestCaseWeb_MesureResourceUsage_" data-uid="AxaFrance.WebEngine.Web.TestCaseWeb.MesureResourceUsage*"></a>
<h4 id="AxaFrance_WebEngine_Web_TestCaseWeb_MesureResourceUsage" data-uid="AxaFrance.WebEngine.Web.TestCaseWeb.MesureResourceUsage">MesureResourceUsage</h4>
<a id="AxaFrance_WebEngine_Web_TestCaseWeb_MeasureResourceUsage_" data-uid="AxaFrance.WebEngine.Web.TestCaseWeb.MeasureResourceUsage*"></a>
<h4 id="AxaFrance_WebEngine_Web_TestCaseWeb_MeasureResourceUsage" data-uid="AxaFrance.WebEngine.Web.TestCaseWeb.MeasureResourceUsage">MeasureResourceUsage</h4>
<div class="markdown level1 summary"><p>When activated, the framework will trace downloaded resources during your test and generates a report on the resources used.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public bool MesureResourceUsage { get; set; }</code></pre>
<pre><code class="lang-csharp hljs">public bool MeasureResourceUsage { get; set; }</code></pre>
</div>
<h5 class="propertyValue">Property Value</h5>
<table class="table table-bordered table-striped table-condensed">
Expand Down
21 changes: 14 additions & 7 deletions docs/api_net/AxaFrance.WebEngine.Web.WebElementDescription.html
Original file line number Diff line number Diff line change
Expand Up @@ -495,7 +495,8 @@ <h3 id="methods">Methods

<a id="AxaFrance_WebEngine_Web_WebElementDescription_ApplyAttribute_" data-uid="AxaFrance.WebEngine.Web.WebElementDescription.ApplyAttribute*"></a>
<h4 id="AxaFrance_WebEngine_Web_WebElementDescription_ApplyAttribute_AxaFrance_WebEngine_Web_FindsByAttribute_" data-uid="AxaFrance.WebEngine.Web.WebElementDescription.ApplyAttribute(AxaFrance.WebEngine.Web.FindsByAttribute)">ApplyAttribute(FindsByAttribute)</h4>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Applies the locator defined in <a class="xref" href="AxaFrance.WebEngine.Web.FindsByAttribute.html">FindsByAttribute</a>. this function is called automatically before <a class="xref" href="AxaFrance.WebEngine.Web.ElementDescription.html#AxaFrance_WebEngine_Web_ElementDescription_InternalFindElements">InternalFindElements()</a></p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
Expand Down Expand Up @@ -720,7 +721,8 @@ <h5 class="overrides">Overrides</h5>

<a id="AxaFrance_WebEngine_Web_WebElementDescription_InternalFindElement_" data-uid="AxaFrance.WebEngine.Web.WebElementDescription.InternalFindElement*"></a>
<h4 id="AxaFrance_WebEngine_Web_WebElementDescription_InternalFindElement" data-uid="AxaFrance.WebEngine.Web.WebElementDescription.InternalFindElement">InternalFindElement()</h4>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Implemente element identifying algorithm, without the need of object synchronization.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
Expand All @@ -737,7 +739,8 @@ <h5 class="returns">Returns</h5>
<tbody>
<tr>
<td><span class="xref">OpenQA.Selenium.IWebElement</span></td>
<td></td>
<td><p>Identified test object.</p>
</td>
</tr>
</tbody>
</table>
Expand All @@ -747,7 +750,8 @@ <h5 class="overrides">Overrides</h5>

<a id="AxaFrance_WebEngine_Web_WebElementDescription_InternalFindElements_" data-uid="AxaFrance.WebEngine.Web.WebElementDescription.InternalFindElements*"></a>
<h4 id="AxaFrance_WebEngine_Web_WebElementDescription_InternalFindElements" data-uid="AxaFrance.WebEngine.Web.WebElementDescription.InternalFindElements">InternalFindElements()</h4>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Implemente element identifying algorithm, without the need of object synchronization.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
Expand All @@ -764,7 +768,8 @@ <h5 class="returns">Returns</h5>
<tbody>
<tr>
<td><span class="xref">System.Collections.Generic.IReadOnlyCollection</span>&lt;<span class="xref">OpenQA.Selenium.IWebElement</span>&gt;</td>
<td></td>
<td><p>Identified test objects</p>
</td>
</tr>
</tbody>
</table>
Expand All @@ -774,7 +779,8 @@ <h5 class="overrides">Overrides</h5>

<a id="AxaFrance_WebEngine_Web_WebElementDescription_InternalGetScreenshot_" data-uid="AxaFrance.WebEngine.Web.WebElementDescription.InternalGetScreenshot*"></a>
<h4 id="AxaFrance_WebEngine_Web_WebElementDescription_InternalGetScreenshot" data-uid="AxaFrance.WebEngine.Web.WebElementDescription.InternalGetScreenshot">InternalGetScreenshot()</h4>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Implemente screenshot generation for the current specific element</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
Expand All @@ -791,7 +797,8 @@ <h5 class="returns">Returns</h5>
<tbody>
<tr>
<td><span class="xref">System.Byte</span>[]</td>
<td></td>
<td><p>The screenshot image in RAW Binary data format.</p>
</td>
</tr>
</tbody>
</table>
Expand Down
2 changes: 1 addition & 1 deletion docs/articles/accessibility.html
Original file line number Diff line number Diff line change
Expand Up @@ -163,7 +163,7 @@ <h4 id="activate-accessibility-testing">Activate accessibility testing</h4>
<p>Accessibility testing should be activated at Test Case level, so the scan engines are initialized and accessibility test result on each scan will be integrated in test report.
To activate accessibility testing on Test Case level, Set the property <a class="xref" href="../api_net/AxaFrance.WebEngine.Web.TestCaseWeb.html#AxaFrance_WebEngine_Web_TestCaseWeb_IsAccessibilityTestEnabled">IsAccessibilityTestEnabled</a> of test case to <code>true</code>. If you want to activate it dynamically via test data, you can provide a test case named <code>Accessibility</code> and set it to <code>True</code></p>
<h4 id="scanning-a-page">Scanning a page</h4>
<p>In a shared action, at the convenient moment call the method &lt;xref:AxaFrance.WebEngine.Web.SharedActionWeb.RunAccessibilityTest(string)&gt;
<p>In a shared action, at the convenient moment call the method <a class="xref" href="../api_net/AxaFrance.WebEngine.Web.SharedActionWeb.html#AxaFrance_WebEngine_Web_SharedActionWeb_RunAccessibilityTest_System_String_">RunAccessibilityTest(String)</a>
This function runs an accessibility scan at current location, then integrates test result to test report. The scan can be performed multiple times on different location within a user journey. With this method, you don’t need to interact directly with classes such as <code>OverallReportBuilder</code> or <code>PageReportBuilder</code></p>
<h3 id="gherkin-based-test-case">Gherkin based test case</h3>
<p>If you are using Gherkin based test case. You’ll need to follow the same steps:
Expand Down
11 changes: 6 additions & 5 deletions docs/articles/env-impact.html
Original file line number Diff line number Diff line change
Expand Up @@ -76,11 +76,11 @@ <h1 id="measure-environmental-impact-during-the-user-journey">Measure environmen
details; you just need to enable the feature and use the provided API to get the information you need.</p>
<h2 id="how-to-activate-resource-usage-tracing">How to activate resource usage tracing?</h2>
<p>Resource usage tracing is enabled at the test case level. The flag is defined at
{xref:AxaFrance.WebEngine.Web.TestCaseWeb.MeasureResourceUsage}. When the flag is enabled before test execution, the framework
<a class="xref" href="../api_net/AxaFrance.WebEngine.Web.TestCaseWeb.html#AxaFrance_WebEngine_Web_TestCaseWeb_MeasureResourceUsage">MeasureResourceUsage</a>. When the flag is enabled before test execution, the framework
will start a network interceptor and save information of all incoming and outgoing traffic in the report.</p>
<p>To enable the feature, there are two ways:</p>
<ul>
<li>Set the property <code>MeasureResourceUsage</code> of {xref:AxaFrance.WebEngine.Web.TestCaseWeb} to true in your code.</li>
<li>Set the property <code>MeasureResourceUsage</code> of <a class="xref" href="../api_net/AxaFrance.WebEngine.Web.TestCaseWeb.html">TestCaseWeb</a> to true in your code.</li>
</ul>
<pre><code class="lang-csharp">public class MyTestCase : TestCaseWeb
{
Expand All @@ -98,12 +98,13 @@ <h2 id="how-to-activate-resource-usage-tracing">How to activate resource usage t
}
</code></pre><ul>
<li>Provide a test parameter named <code>ResourceUsage</code> and set it to True in your test data.
For example, you can provide the parameter via Excel test data on the test cases you want to activate. Resource Usage
[../images/resource-usage.png]</li>
For example, you can provide the parameter via Excel test data on the test cases you want to activate.
<img src="../images/resource-usage.png" alt="Resource Usage"></li>
</ul>
<h2 id="how-are-the-results-displayed">How are the results displayed?</h2>
<p>When resource usage tracing is enabled, the framework will save the related raw data in the report. The report will be analyzed
and visualized in the Report Viewer: Resource Usage Report [../images/resource-usage-report.png]</p>
and visualized in the Report Viewer:</p>
<p><img src="../images/resource-usage-report.png" alt="Resource Usage Report"></p>
<p>The report will show the following information:</p>
<ul>
<li>On the top-left, the size of responses (in bytes) categorized by type: Font, script, CSS, and the HTML document itself.</li>
Expand Down
3 changes: 3 additions & 0 deletions docs/articles/toc.html
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,9 @@
<li>
<a href="accessibility.html" name="" title="Web Accessibility Testing">Web Accessibility Testing</a>
</li>
<li>
<a href="env-impact.html" name="" title="Measure Environmental Impact">Measure Environmental Impact</a>
</li>
<li>
<span class="expand-stub"></span>
<a href="excel-addin.html" name="" title="WebEngine Add-in for Excel">WebEngine Add-in for Excel</a>
Expand Down
2 changes: 1 addition & 1 deletion docs/articles/webengine-app.html
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,7 @@ <h2 id="use-appfactory-to-manage-apppackage-and-device-connection">Use AppFactor
<p><a class="xref" href="../api_net/AxaFrance.WebEngine.MobileApp.AppFactory.html">AppFactory</a> is used to initialize Device cloud connection and app package uploading.</p>
<p>Before launching the automated tests on Mobile devices, you&#39;ll need to tell Appium Server to start the application under test.
Or if the application is not yet installed, to install it.
WebEngine Framework can upload the app package to compatible platforms, by calling the method &lt;xref:AxaFrance.WebEngine.MobileApp.AppFactory.UploadAppPackage(System.String,System.String,System.String,System.String)&gt;, it returns the real <code>AppId</code> to be used to connect to remote devices.</p>
WebEngine Framework can upload the app package to compatible platforms, this actions is automatic according to the platform provider, it returns the real <code>AppId</code> to be used to connect to remote devices.</p>
<p>Then you can use <a class="xref" href="../api_net/AxaFrance.WebEngine.MobileApp.AppFactory.html#AxaFrance_WebEngine_MobileApp_AppFactory_GetDriver_AxaFrance_WebEngine_Platform_">GetDriver(Platform)</a> to get AppiumDriver in order to interact with test scripts.
According to your test settings, AppiumDriver can be either:</p>
<ul>
Expand Down
4 changes: 2 additions & 2 deletions docs/articles/webengine-web.html
Original file line number Diff line number Diff line change
Expand Up @@ -78,8 +78,8 @@ <h1 id="test-web-applications">Test Web Applications</h1>
</ul>
<p>In WebEngine Framework, we have provided : </p>
<ul>
<li>&lt;xref:AXA.WebEngine.Web.BrowserFactory&gt; to easily manage web browsers and selenium webdrivers </li>
<li>&lt;xref:AXA.WebEngine.Web.PageModel&gt; and &lt;xref:AXA.WebEngine.Web.WebElementDescription&gt; to manage Web Elements.</li>
<li><a class="xref" href="../api_net/AxaFrance.WebEngine.Web.BrowserFactory.html">BrowserFactory</a> to easily manage web browsers and selenium webdrivers </li>
<li><a class="xref" href="../api_net/AxaFrance.WebEngine.Web.PageModel.html">PageModel</a> and <a class="xref" href="../api_net/AxaFrance.WebEngine.Web.WebElementDescription.html">WebElementDescription</a> to manage Web Elements.</li>
</ul>
<h2 id="prerequisites">Prerequisites</h2>
<p>To test web applications with WebEngine Framework, you&#39;ll need to have follow knowledges as pre-requisites:</p>
Expand Down
Loading

0 comments on commit 9be1136

Please sign in to comment.