Skip to content

Commit bdf8a6b

Browse files
AliouDIAITEAliouDIAITE
committed
update docs and init javadocs (#157)
Documentation of SCT Signed-off-by: Aliou DIAITE <[email protected]> Rename doc to docs and update config.yml Signed-off-by: Aliou DIAITE <[email protected]> Set theme jekyll-theme-cayman [117] : update readme and refactoring Signed-off-by: Aliou DIAITE <[email protected]> [117] : update readme file and github pages documentation Signed-off-by: Aliou DIAITE <[email protected]> [117] : update readme and refactoring and comment methods Signed-off-by: Aliou DIAITE <[email protected]> [115] : update javdoc Signed-off-by: Aliou DIAITE <[email protected]> [115] update docs and init javadocs Signed-off-by: Samir Romdhani <[email protected]> Initialisation Signed-off-by: Aliou DIAITE <[email protected]> Set theme jekyll-theme-cayman [117] : update readme and refactoring Signed-off-by: Aliou DIAITE <[email protected]> [117] : update readme file and github pages documentation Signed-off-by: Aliou DIAITE <[email protected]> [117] : update readme and refactoring and comment methods Signed-off-by: Aliou DIAITE <[email protected]> [115] update docs and init javadocs Signed-off-by: Samir Romdhani <[email protected]> add javadoc plugin (#132) Signed-off-by: Samir Romdhani <[email protected]> Signed-off-by: Samir Romdhani <[email protected]> fixed re-use Signed-off-by: Samir Romdhani <[email protected]> Docs: Update Java docs repository (#134) * automated javadocs updates (#133) Signed-off-by: Samir Romdhani <[email protected]> Signed-off-by: Samir Romdhani <[email protected]> * updated Java docs repository Signed-off-by: Samir Romdhani <[email protected]> Co-authored-by: Samir Romdhani <[email protected]> Co-authored-by: Config CI Robot <[email protected]> updated Java docs repository (#137) Co-authored-by: Config CI Robot <[email protected]> fixed re-use (#138) updated Java docs repository (#143) Signed-off-by: Config CI Robot <[email protected]> Signed-off-by: Config CI Robot <[email protected]> Co-authored-by: Config CI Robot <[email protected]> Signed-off-by: Samir Romdhani <[email protected]> update javadoc WIP Signed-off-by: Samir Romdhani <[email protected]> update javadoc, packages & classes Signed-off-by: Samir Romdhani <[email protected]> Feat/update javadoc (#150) * Update javadoc Signed-off-by: Aliou DIAITE <[email protected]> * WIP add javadoc to dtt module elements Signed-off-by: Aliou DIAITE <[email protected]> * WIP add javadoc to ied and sstation directories elements Signed-off-by: Aliou DIAITE <[email protected]> * methode documentation done Signed-off-by: Aliou DIAITE <[email protected]> Signed-off-by: Aliou DIAITE <[email protected]> javadoc for sct.app package and class (#151) Update javadoc (package and class) Signed-off-by: Aliou DIAITE <[email protected]> * WIP add javadoc to dtt module elements Signed-off-by: Aliou DIAITE <[email protected]> * WIP add javadoc to ied and sstation directories elements Signed-off-by: Aliou DIAITE <[email protected]> * methode documentation done Signed-off-by: Aliou DIAITE <[email protected]> * javadoc for sct.app package and class Signed-off-by: Samir Romdhani <[email protected]> Signed-off-by: Aliou DIAITE <[email protected]> Signed-off-by: Samir Romdhani <[email protected]> Co-authored-by: Aliou DIAITE <[email protected]> Set develop as reference branch for documentation Signed-off-by: Aliou DIAITE <[email protected]> Signed-off-by: Aliou DIAITE <[email protected]>
1 parent 4c80b8c commit bdf8a6b

File tree

682 files changed

+306523
-4
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

682 files changed

+306523
-4
lines changed

‎docs/javadoc/allclasses-index.html‎

Lines changed: 1967 additions & 0 deletions
Large diffs are not rendered by default.

‎docs/javadoc/allclasses.html‎

Lines changed: 321 additions & 0 deletions
Large diffs are not rendered by default.

‎docs/javadoc/allpackages-index.html‎

Lines changed: 234 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,234 @@
1+
<!DOCTYPE HTML>
2+
<!-- NewPage -->
3+
<html lang="fr">
4+
<head>
5+
<!-- Generated by javadoc (11.0.11) on Thu Sep 15 11:47:44 CEST 2022 -->
6+
<title>All Packages (COMPAS-SCT local-SNAPSHOT API)</title>
7+
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
8+
<meta name="dc.created" content="2022-09-15">
9+
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
10+
<link rel="stylesheet" type="text/css" href="jquery/jquery-ui.css" title="Style">
11+
<script type="text/javascript" src="script.js"></script>
12+
<script type="text/javascript" src="jquery/jszip/dist/jszip.min.js"></script>
13+
<script type="text/javascript" src="jquery/jszip-utils/dist/jszip-utils.min.js"></script>
14+
<!--[if IE]>
15+
<script type="text/javascript" src="jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script>
16+
<![endif]-->
17+
<script type="text/javascript" src="jquery/jquery-3.5.1.js"></script>
18+
<script type="text/javascript" src="jquery/jquery-ui.js"></script>
19+
</head>
20+
<body>
21+
<script type="text/javascript"><!--
22+
try {
23+
if (location.href.indexOf('is-external=true') == -1) {
24+
parent.document.title="All Packages (COMPAS-SCT local-SNAPSHOT API)";
25+
}
26+
}
27+
catch(err) {
28+
}
29+
//-->
30+
var pathtoroot = "./";
31+
var useModuleDirectories = false;
32+
loadScripts(document, 'script');</script>
33+
<noscript>
34+
<div>JavaScript is disabled on your browser.</div>
35+
</noscript>
36+
<header role="banner">
37+
<nav role="navigation">
38+
<div class="fixedNav">
39+
<!-- ========= START OF TOP NAVBAR ======= -->
40+
<div class="topNav"><a id="navbar.top">
41+
<!-- -->
42+
</a>
43+
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
44+
<a id="navbar.top.firstrow">
45+
<!-- -->
46+
</a>
47+
<ul class="navList" title="Navigation">
48+
<li><a href="index.html">Overview</a></li>
49+
<li>Package</li>
50+
<li>Class</li>
51+
<li>Use</li>
52+
<li><a href="overview-tree.html">Tree</a></li>
53+
<li><a href="deprecated-list.html">Deprecated</a></li>
54+
<li><a href="index-all.html">Index</a></li>
55+
<li><a href="help-doc.html">Help</a></li>
56+
</ul>
57+
</div>
58+
<div class="subNav">
59+
<ul class="navList" id="allclasses_navbar_top">
60+
<li><a href="allclasses.html">All&nbsp;Classes</a></li>
61+
</ul>
62+
<ul class="navListSearch">
63+
<li><label for="search">SEARCH:</label>
64+
<input type="text" id="search" value="search" disabled="disabled">
65+
<input type="reset" id="reset" value="reset" disabled="disabled">
66+
</li>
67+
</ul>
68+
<div>
69+
<script type="text/javascript"><!--
70+
allClassesLink = document.getElementById("allclasses_navbar_top");
71+
if(window==top) {
72+
allClassesLink.style.display = "block";
73+
}
74+
else {
75+
allClassesLink.style.display = "none";
76+
}
77+
//-->
78+
</script>
79+
<noscript>
80+
<div>JavaScript is disabled on your browser.</div>
81+
</noscript>
82+
</div>
83+
<a id="skip.navbar.top">
84+
<!-- -->
85+
</a></div>
86+
<!-- ========= END OF TOP NAVBAR ========= -->
87+
</div>
88+
<div class="navPadding">&nbsp;</div>
89+
<script type="text/javascript"><!--
90+
$('.navPadding').css('padding-top', $('.fixedNav').css("height"));
91+
//-->
92+
</script>
93+
</nav>
94+
</header>
95+
<main role="main">
96+
<div class="header">
97+
<h1 title="All&amp;nbsp;Packages" class="title">All&nbsp;Packages</h1>
98+
</div>
99+
<div class="allPackagesContainer">
100+
<ul class="blockList">
101+
<li class="blockList">
102+
<table class="packagesSummary">
103+
<caption><span>Package Summary</span><span class="tabEnd">&nbsp;</span></caption>
104+
<tr>
105+
<th class="colFirst" scope="col">Package</th>
106+
<th class="colLast" scope="col">Description</th>
107+
</tr>
108+
<tbody>
109+
<tr class="altColor">
110+
<th class="colFirst" scope="row"><a href="org/lfenergy/compas/scl2007b4/model/package-summary.html">org.lfenergy.compas.scl2007b4.model</a></th>
111+
<td class="colLast">&nbsp;</td>
112+
</tr>
113+
<tr class="rowColor">
114+
<th class="colFirst" scope="row"><a href="org/lfenergy/compas/sct/app/package-summary.html">org.lfenergy.compas.sct.app</a></th>
115+
<td class="colLast">
116+
<div class="block">sct-app is a group of automation services</div>
117+
</td>
118+
</tr>
119+
<tr class="altColor">
120+
<th class="colFirst" scope="row"><a href="org/lfenergy/compas/sct/commons/dto/package-summary.html">org.lfenergy.compas.sct.commons.dto</a></th>
121+
<td class="colLast">
122+
<div class="block">sct.commons.dto is a group of DTO utils for operating on
123+
<a href="org/lfenergy/compas/scl2007b4/model/SCL.html" title="class in org.lfenergy.compas.scl2007b4.model"><code>SCL</code></a> services</div>
124+
</td>
125+
</tr>
126+
<tr class="rowColor">
127+
<th class="colFirst" scope="row"><a href="org/lfenergy/compas/sct/commons/exception/package-summary.html">org.lfenergy.compas.sct.commons.exception</a></th>
128+
<td class="colLast">&nbsp;</td>
129+
</tr>
130+
<tr class="altColor">
131+
<th class="colFirst" scope="row"><a href="org/lfenergy/compas/sct/commons/scl/package-summary.html">org.lfenergy.compas.sct.commons.scl</a></th>
132+
<td class="colLast">
133+
<div class="block">commons.scl is a group of services for operating on
134+
<a href="org/lfenergy/compas/scl2007b4/model/THeader.html" title="class in org.lfenergy.compas.scl2007b4.model"><code>Header</code></a> ,
135+
<a href="org/lfenergy/compas/scl2007b4/model/TSubstation.html" title="class in org.lfenergy.compas.scl2007b4.model"><code>Substation</code></a> ,
136+
<a href="org/lfenergy/compas/scl2007b4/model/TCommunication.html" title="class in org.lfenergy.compas.scl2007b4.model"><code>Communication</code></a> ,
137+
<a href="org/lfenergy/compas/scl2007b4/model/TIED.html" title="class in org.lfenergy.compas.scl2007b4.model"><code>IED</code></a> ,
138+
<a href="org/lfenergy/compas/scl2007b4/model/TDataTypeTemplates.html" title="class in org.lfenergy.compas.scl2007b4.model"><code>DataTypeTemplates</code></a> objects</div>
139+
</td>
140+
</tr>
141+
<tr class="rowColor">
142+
<th class="colFirst" scope="row"><a href="org/lfenergy/compas/sct/commons/scl/com/package-summary.html">org.lfenergy.compas.sct.commons.scl.com</a></th>
143+
<td class="colLast">
144+
<div class="block">scl.com is a group of services for operating on
145+
<a href="org/lfenergy/compas/scl2007b4/model/TCommunication.html" title="class in org.lfenergy.compas.scl2007b4.model"><code>Communication</code></a> object</div>
146+
</td>
147+
</tr>
148+
<tr class="altColor">
149+
<th class="colFirst" scope="row"><a href="org/lfenergy/compas/sct/commons/scl/dtt/package-summary.html">org.lfenergy.compas.sct.commons.scl.dtt</a></th>
150+
<td class="colLast">
151+
<div class="block">scl.dtt is a group of services for operating on
152+
<a href="org/lfenergy/compas/scl2007b4/model/TDataTypeTemplates.html" title="class in org.lfenergy.compas.scl2007b4.model"><code>DataTypeTemplates</code></a> object</div>
153+
</td>
154+
</tr>
155+
<tr class="rowColor">
156+
<th class="colFirst" scope="row"><a href="org/lfenergy/compas/sct/commons/scl/header/package-summary.html">org.lfenergy.compas.sct.commons.scl.header</a></th>
157+
<td class="colLast">
158+
<div class="block">scl.header is a group of services for operating on
159+
<a href="org/lfenergy/compas/scl2007b4/model/THeader.html" title="class in org.lfenergy.compas.scl2007b4.model"><code>Header</code></a> object</div>
160+
</td>
161+
</tr>
162+
<tr class="altColor">
163+
<th class="colFirst" scope="row"><a href="org/lfenergy/compas/sct/commons/scl/ied/package-summary.html">org.lfenergy.compas.sct.commons.scl.ied</a></th>
164+
<td class="colLast">
165+
<div class="block">scl.ied is a group of services for operating on
166+
<a href="org/lfenergy/compas/scl2007b4/model/TIED.html" title="class in org.lfenergy.compas.scl2007b4.model"><code>IED</code></a> object</div>
167+
</td>
168+
</tr>
169+
<tr class="rowColor">
170+
<th class="colFirst" scope="row"><a href="org/lfenergy/compas/sct/commons/scl/sstation/package-summary.html">org.lfenergy.compas.sct.commons.scl.sstation</a></th>
171+
<td class="colLast">
172+
<div class="block">scl.sstation is a group of services for operating on
173+
<a href="org/lfenergy/compas/scl2007b4/model/TSubstation.html" title="class in org.lfenergy.compas.scl2007b4.model"><code>Substation</code></a> object</div>
174+
</td>
175+
</tr>
176+
<tr class="altColor">
177+
<th class="colFirst" scope="row"><a href="org/lfenergy/compas/sct/commons/util/package-summary.html">org.lfenergy.compas.sct.commons.util</a></th>
178+
<td class="colLast">&nbsp;</td>
179+
</tr>
180+
</tbody>
181+
</table>
182+
</li>
183+
</ul>
184+
</div>
185+
</main>
186+
<footer role="contentinfo">
187+
<nav role="navigation">
188+
<!-- ======= START OF BOTTOM NAVBAR ====== -->
189+
<div class="bottomNav"><a id="navbar.bottom">
190+
<!-- -->
191+
</a>
192+
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
193+
<a id="navbar.bottom.firstrow">
194+
<!-- -->
195+
</a>
196+
<ul class="navList" title="Navigation">
197+
<li><a href="index.html">Overview</a></li>
198+
<li>Package</li>
199+
<li>Class</li>
200+
<li>Use</li>
201+
<li><a href="overview-tree.html">Tree</a></li>
202+
<li><a href="deprecated-list.html">Deprecated</a></li>
203+
<li><a href="index-all.html">Index</a></li>
204+
<li><a href="help-doc.html">Help</a></li>
205+
</ul>
206+
</div>
207+
<div class="subNav">
208+
<ul class="navList" id="allclasses_navbar_bottom">
209+
<li><a href="allclasses.html">All&nbsp;Classes</a></li>
210+
</ul>
211+
<div>
212+
<script type="text/javascript"><!--
213+
allClassesLink = document.getElementById("allclasses_navbar_bottom");
214+
if(window==top) {
215+
allClassesLink.style.display = "block";
216+
}
217+
else {
218+
allClassesLink.style.display = "none";
219+
}
220+
//-->
221+
</script>
222+
<noscript>
223+
<div>JavaScript is disabled on your browser.</div>
224+
</noscript>
225+
</div>
226+
<a id="skip.navbar.bottom">
227+
<!-- -->
228+
</a></div>
229+
<!-- ======== END OF BOTTOM NAVBAR ======= -->
230+
</nav>
231+
<p class="legalCopy"><small>Copyright &#169; 2022. All rights reserved.</small></p>
232+
</footer>
233+
</body>
234+
</html>

0 commit comments

Comments
 (0)