Updated Javadoc for website

sylvainhalle · Jul 2, 2018 · 8505158 · 8505158
1 parent 6bd0e59
commit 8505158
Show file tree

Hide file tree

Showing 105 changed files with 4,989 additions and 358 deletions.
diff --git a/dictionary.txt b/dictionary.txt
@@ -0,0 +1,8 @@
+textbox
+Cornipickle
+Cornipickle’s
+Cornipickle's
+runtime
+Runtime
+CSS
+HTML
diff --git a/docs/javadoc/allclasses-frame.html b/docs/javadoc/allclasses-frame.html
@@ -2,10 +2,10 @@
 <!-- NewPage -->
 <html lang="en">
 <head>
-<!-- Generated by javadoc (1.8.0_171) on Sun Jun 24 18:35:08 EDT 2018 -->
+<!-- Generated by javadoc (1.8.0_171) on Fri Jun 29 09:14:08 EDT 2018 -->
 <meta http-equiv="Content-Type" content="text/html; charset=utf8">
 <title>All Classes (TeXtidote Documentation)</title>
-<meta name="date" content="2018-06-24">
+<meta name="date" content="2018-06-29">
 <link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
 <script type="text/javascript" src="script.js"></script>
 </head>
@@ -27,18 +27,23 @@ <h1 class="bar">All&nbsp;Classes</h1>
 <li><a href="ca/uqac/lif/textidote/rules/CheckNoBreak.html" title="class in ca.uqac.lif.textidote.rules" target="classFrame">CheckNoBreak</a></li>
 <li><a href="ca/uqac/lif/textidote/rules/CheckSubsections.html" title="class in ca.uqac.lif.textidote.rules" target="classFrame">CheckSubsections</a></li>
 <li><a href="ca/uqac/lif/textidote/rules/CheckSubsectionSize.html" title="class in ca.uqac.lif.textidote.rules" target="classFrame">CheckSubsectionSize</a></li>
-<li><a href="ca/uqac/lif/textidote/Detexer.html" title="class in ca.uqac.lif.textidote" target="classFrame">Detexer</a></li>
+<li><a href="ca/uqac/lif/textidote/cleaning/CompositeCleaner.html" title="class in ca.uqac.lif.textidote.cleaning" target="classFrame">CompositeCleaner</a></li>
 <li><a href="ca/uqac/lif/textidote/render/HtmlAdviceRenderer.html" title="class in ca.uqac.lif.textidote.render" target="classFrame">HtmlAdviceRenderer</a></li>
 <li><a href="ca/uqac/lif/textidote/rules/LanguageFactory.html" title="class in ca.uqac.lif.textidote.rules" target="classFrame">LanguageFactory</a></li>
+<li><a href="ca/uqac/lif/textidote/cleaning/latex/LatexCleaner.html" title="class in ca.uqac.lif.textidote.cleaning.latex" target="classFrame">LatexCleaner</a></li>
 <li><a href="ca/uqac/lif/textidote/Linter.html" title="class in ca.uqac.lif.textidote" target="classFrame">Linter</a></li>
+<li><a href="ca/uqac/lif/textidote/LinterException.html" title="class in ca.uqac.lif.textidote" target="classFrame">LinterException</a></li>
 <li><a href="ca/uqac/lif/textidote/Main.html" title="class in ca.uqac.lif.textidote" target="classFrame">Main</a></li>
 <li><a href="ca/uqac/lif/textidote/as/Match.html" title="class in ca.uqac.lif.textidote.as" target="classFrame">Match</a></li>
 <li><a href="ca/uqac/lif/util/NullPrintStream.html" title="class in ca.uqac.lif.util" target="classFrame">NullPrintStream</a></li>
 <li><a href="ca/uqac/lif/textidote/as/Position.html" title="class in ca.uqac.lif.textidote.as" target="classFrame">Position</a></li>
 <li><a href="ca/uqac/lif/textidote/as/Position.Nowhere.html" title="class in ca.uqac.lif.textidote.as" target="classFrame">Position.Nowhere</a></li>
 <li><a href="ca/uqac/lif/textidote/as/Range.html" title="class in ca.uqac.lif.textidote.as" target="classFrame">Range</a></li>
 <li><a href="ca/uqac/lif/textidote/rules/RegexRule.html" title="class in ca.uqac.lif.textidote.rules" target="classFrame">RegexRule</a></li>
+<li><a href="ca/uqac/lif/textidote/cleaning/ReplacementCleaner.html" title="class in ca.uqac.lif.textidote.cleaning" target="classFrame">ReplacementCleaner</a></li>
 <li><a href="ca/uqac/lif/textidote/Rule.html" title="class in ca.uqac.lif.textidote" target="classFrame">Rule</a></li>
+<li><a href="ca/uqac/lif/textidote/cleaning/TextCleaner.html" title="class in ca.uqac.lif.textidote.cleaning" target="classFrame">TextCleaner</a></li>
+<li><a href="ca/uqac/lif/textidote/cleaning/TextCleanerException.html" title="class in ca.uqac.lif.textidote.cleaning" target="classFrame">TextCleanerException</a></li>
 </ul>
 </div>
 </body>

diff --git a/docs/javadoc/allclasses-noframe.html b/docs/javadoc/allclasses-noframe.html
@@ -2,10 +2,10 @@
 <!-- NewPage -->
 <html lang="en">
 <head>
-<!-- Generated by javadoc (1.8.0_171) on Sun Jun 24 18:35:08 EDT 2018 -->
+<!-- Generated by javadoc (1.8.0_171) on Fri Jun 29 09:14:08 EDT 2018 -->
 <meta http-equiv="Content-Type" content="text/html; charset=utf8">
 <title>All Classes (TeXtidote Documentation)</title>
-<meta name="date" content="2018-06-24">
+<meta name="date" content="2018-06-29">
 <link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
 <script type="text/javascript" src="script.js"></script>
 </head>
@@ -27,18 +27,23 @@ <h1 class="bar">All&nbsp;Classes</h1>
 <li><a href="ca/uqac/lif/textidote/rules/CheckNoBreak.html" title="class in ca.uqac.lif.textidote.rules">CheckNoBreak</a></li>
 <li><a href="ca/uqac/lif/textidote/rules/CheckSubsections.html" title="class in ca.uqac.lif.textidote.rules">CheckSubsections</a></li>
 <li><a href="ca/uqac/lif/textidote/rules/CheckSubsectionSize.html" title="class in ca.uqac.lif.textidote.rules">CheckSubsectionSize</a></li>
-<li><a href="ca/uqac/lif/textidote/Detexer.html" title="class in ca.uqac.lif.textidote">Detexer</a></li>
+<li><a href="ca/uqac/lif/textidote/cleaning/CompositeCleaner.html" title="class in ca.uqac.lif.textidote.cleaning">CompositeCleaner</a></li>
 <li><a href="ca/uqac/lif/textidote/render/HtmlAdviceRenderer.html" title="class in ca.uqac.lif.textidote.render">HtmlAdviceRenderer</a></li>
 <li><a href="ca/uqac/lif/textidote/rules/LanguageFactory.html" title="class in ca.uqac.lif.textidote.rules">LanguageFactory</a></li>
+<li><a href="ca/uqac/lif/textidote/cleaning/latex/LatexCleaner.html" title="class in ca.uqac.lif.textidote.cleaning.latex">LatexCleaner</a></li>
 <li><a href="ca/uqac/lif/textidote/Linter.html" title="class in ca.uqac.lif.textidote">Linter</a></li>
+<li><a href="ca/uqac/lif/textidote/LinterException.html" title="class in ca.uqac.lif.textidote">LinterException</a></li>
 <li><a href="ca/uqac/lif/textidote/Main.html" title="class in ca.uqac.lif.textidote">Main</a></li>
 <li><a href="ca/uqac/lif/textidote/as/Match.html" title="class in ca.uqac.lif.textidote.as">Match</a></li>
 <li><a href="ca/uqac/lif/util/NullPrintStream.html" title="class in ca.uqac.lif.util">NullPrintStream</a></li>
 <li><a href="ca/uqac/lif/textidote/as/Position.html" title="class in ca.uqac.lif.textidote.as">Position</a></li>
 <li><a href="ca/uqac/lif/textidote/as/Position.Nowhere.html" title="class in ca.uqac.lif.textidote.as">Position.Nowhere</a></li>
 <li><a href="ca/uqac/lif/textidote/as/Range.html" title="class in ca.uqac.lif.textidote.as">Range</a></li>
 <li><a href="ca/uqac/lif/textidote/rules/RegexRule.html" title="class in ca.uqac.lif.textidote.rules">RegexRule</a></li>
+<li><a href="ca/uqac/lif/textidote/cleaning/ReplacementCleaner.html" title="class in ca.uqac.lif.textidote.cleaning">ReplacementCleaner</a></li>
 <li><a href="ca/uqac/lif/textidote/Rule.html" title="class in ca.uqac.lif.textidote">Rule</a></li>
+<li><a href="ca/uqac/lif/textidote/cleaning/TextCleaner.html" title="class in ca.uqac.lif.textidote.cleaning">TextCleaner</a></li>
+<li><a href="ca/uqac/lif/textidote/cleaning/TextCleanerException.html" title="class in ca.uqac.lif.textidote.cleaning">TextCleanerException</a></li>
 </ul>
 </div>
 </body>

diff --git a/docs/javadoc/ca/uqac/lif/textidote/Advice.html b/docs/javadoc/ca/uqac/lif/textidote/Advice.html
@@ -2,10 +2,10 @@
 <!-- NewPage -->
 <html lang="en">
 <head>
-<!-- Generated by javadoc (1.8.0_171) on Sun Jun 24 18:35:07 EDT 2018 -->
+<!-- Generated by javadoc (1.8.0_171) on Fri Jun 29 09:14:07 EDT 2018 -->
 <meta http-equiv="Content-Type" content="text/html; charset=utf8">
 <title>Advice (TeXtidote Documentation)</title>
-<meta name="date" content="2018-06-24">
+<meta name="date" content="2018-06-29">
 <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
 <script type="text/javascript" src="../../../../script.js"></script>
 </head>

diff --git a/docs/javadoc/ca/uqac/lif/textidote/AdviceRenderer.html b/docs/javadoc/ca/uqac/lif/textidote/AdviceRenderer.html
@@ -2,10 +2,10 @@
 <!-- NewPage -->
 <html lang="en">
 <head>
-<!-- Generated by javadoc (1.8.0_171) on Sun Jun 24 18:35:07 EDT 2018 -->
+<!-- Generated by javadoc (1.8.0_171) on Fri Jun 29 09:14:07 EDT 2018 -->
 <meta http-equiv="Content-Type" content="text/html; charset=utf8">
 <title>AdviceRenderer (TeXtidote Documentation)</title>
-<meta name="date" content="2018-06-24">
+<meta name="date" content="2018-06-29">
 <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
 <script type="text/javascript" src="../../../../script.js"></script>
 </head>
@@ -51,7 +51,7 @@
 <div class="subNav">
 <ul class="navList">
 <li><a href="../../../../ca/uqac/lif/textidote/Advice.html" title="class in ca.uqac.lif.textidote"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
-<li><a href="../../../../ca/uqac/lif/textidote/Detexer.html" title="class in ca.uqac.lif.textidote"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
+<li><a href="../../../../ca/uqac/lif/textidote/Linter.html" title="class in ca.uqac.lif.textidote"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
 </ul>
 <ul class="navList">
 <li><a href="../../../../index.html?ca/uqac/lif/textidote/AdviceRenderer.html" target="_top">Frames</a></li>
@@ -290,7 +290,7 @@ <h4>render</h4>
 <div class="subNav">
 <ul class="navList">
 <li><a href="../../../../ca/uqac/lif/textidote/Advice.html" title="class in ca.uqac.lif.textidote"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
-<li><a href="../../../../ca/uqac/lif/textidote/Detexer.html" title="class in ca.uqac.lif.textidote"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
+<li><a href="../../../../ca/uqac/lif/textidote/Linter.html" title="class in ca.uqac.lif.textidote"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
 </ul>
 <ul class="navList">
 <li><a href="../../../../index.html?ca/uqac/lif/textidote/AdviceRenderer.html" target="_top">Frames</a></li>

diff --git a/docs/javadoc/ca/uqac/lif/textidote/Linter.html b/docs/javadoc/ca/uqac/lif/textidote/Linter.html
@@ -2,10 +2,10 @@
 <!-- NewPage -->
 <html lang="en">
 <head>
-<!-- Generated by javadoc (1.8.0_171) on Sun Jun 24 18:35:07 EDT 2018 -->
+<!-- Generated by javadoc (1.8.0_171) on Fri Jun 29 09:14:07 EDT 2018 -->
 <meta http-equiv="Content-Type" content="text/html; charset=utf8">
 <title>Linter (TeXtidote Documentation)</title>
-<meta name="date" content="2018-06-24">
+<meta name="date" content="2018-06-29">
 <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
 <script type="text/javascript" src="../../../../script.js"></script>
 </head>
@@ -50,8 +50,8 @@
 </div>
 <div class="subNav">
 <ul class="navList">
-<li><a href="../../../../ca/uqac/lif/textidote/Detexer.html" title="class in ca.uqac.lif.textidote"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
-<li><a href="../../../../ca/uqac/lif/textidote/Main.html" title="class in ca.uqac.lif.textidote"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
+<li><a href="../../../../ca/uqac/lif/textidote/AdviceRenderer.html" title="class in ca.uqac.lif.textidote"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
+<li><a href="../../../../ca/uqac/lif/textidote/LinterException.html" title="class in ca.uqac.lif.textidote"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
 </ul>
 <ul class="navList">
 <li><a href="../../../../index.html?ca/uqac/lif/textidote/Linter.html" target="_top">Frames</a></li>
@@ -132,8 +132,8 @@ <h3>Field Summary</h3>
 <th class="colLast" scope="col">Field and Description</th>
 </tr>
 <tr class="altColor">
-<td class="colFirst"><code>protected <a href="../../../../ca/uqac/lif/textidote/Detexer.html" title="class in ca.uqac.lif.textidote">Detexer</a></code></td>
-<td class="colLast"><code><span class="memberNameLink"><a href="../../../../ca/uqac/lif/textidote/Linter.html#m_detexer">m_detexer</a></span></code>
+<td class="colFirst"><code>protected <a href="../../../../ca/uqac/lif/textidote/cleaning/TextCleaner.html" title="class in ca.uqac.lif.textidote.cleaning">TextCleaner</a></code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../ca/uqac/lif/textidote/Linter.html#m_cleaner">m_cleaner</a></span></code>
 <div class="block">The detexer used to clean the document</div>
 </td>
 </tr>
@@ -164,7 +164,7 @@ <h3>Constructor Summary</h3>
 <th class="colOne" scope="col">Constructor and Description</th>
 </tr>
 <tr class="altColor">
-<td class="colOne"><code><span class="memberNameLink"><a href="../../../../ca/uqac/lif/textidote/Linter.html#Linter--">Linter</a></span>()</code>
+<td class="colOne"><code><span class="memberNameLink"><a href="../../../../ca/uqac/lif/textidote/Linter.html#Linter-ca.uqac.lif.textidote.cleaning.TextCleaner-">Linter</a></span>(<a href="../../../../ca/uqac/lif/textidote/cleaning/TextCleaner.html" title="class in ca.uqac.lif.textidote.cleaning">TextCleaner</a>&nbsp;cleaner)</code>
 <div class="block">Creates a new empty linter object</div>
 </td>
 </tr>
@@ -208,8 +208,8 @@ <h3>Method Summary</h3>
 </td>
 </tr>
 <tr id="i4" class="altColor">
-<td class="colFirst"><code><a href="../../../../ca/uqac/lif/textidote/Detexer.html" title="class in ca.uqac.lif.textidote">Detexer</a></code></td>
-<td class="colLast"><code><span class="memberNameLink"><a href="../../../../ca/uqac/lif/textidote/Linter.html#getDetexer--">getDetexer</a></span>()</code>
+<td class="colFirst"><code><a href="../../../../ca/uqac/lif/textidote/cleaning/TextCleaner.html" title="class in ca.uqac.lif.textidote.cleaning">TextCleaner</a></code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../ca/uqac/lif/textidote/Linter.html#getTextCleaner--">getTextCleaner</a></span>()</code>
 <div class="block">Gets the instance of detexer used by this linter.</div>
 </td>
 </tr>
@@ -255,13 +255,13 @@ <h4>m_rulesDetexed</h4>
 <div class="block"><p>The list of rules that will be evaluated</p></div>
 </li>
 </ul>
-<a name="m_detexer">
+<a name="m_cleaner">
 <!--   -->
 </a>
 <ul class="blockListLast">
 <li class="blockList">
-<h4>m_detexer</h4>
-<pre>protected&nbsp;<a href="../../../../ca/uqac/lif/textidote/Detexer.html" title="class in ca.uqac.lif.textidote">Detexer</a> m_detexer</pre>
+<h4>m_cleaner</h4>
+<pre>protected&nbsp;<a href="../../../../ca/uqac/lif/textidote/cleaning/TextCleaner.html" title="class in ca.uqac.lif.textidote.cleaning">TextCleaner</a> m_cleaner</pre>
 <div class="block"><p>The detexer used to clean the document</p></div>
 </li>
 </ul>
@@ -273,13 +273,13 @@ <h4>m_detexer</h4>
 <!--   -->
 </a>
 <h3>Constructor Detail</h3>
-<a name="Linter--">
+<a name="Linter-ca.uqac.lif.textidote.cleaning.TextCleaner-">
 <!--   -->
 </a>
 <ul class="blockListLast">
 <li class="blockList">
 <h4>Linter</h4>
-<pre>public&nbsp;Linter()</pre>
+<pre>public&nbsp;Linter(<a href="../../../../ca/uqac/lif/textidote/cleaning/TextCleaner.html" title="class in ca.uqac.lif.textidote.cleaning">TextCleaner</a>&nbsp;cleaner)</pre>
 <div class="block"><p>Creates a new empty linter object</p></div>
 </li>
 </ul>
@@ -355,13 +355,13 @@ <h4>addDetexed</h4>
 </dl>
 </li>
 </ul>
-<a name="getDetexer--">
+<a name="getTextCleaner--">
 <!--   -->
 </a>
 <ul class="blockListLast">
 <li class="blockList">
-<h4>getDetexer</h4>
-<pre>public&nbsp;<a href="../../../../ca/uqac/lif/textidote/Detexer.html" title="class in ca.uqac.lif.textidote">Detexer</a>&nbsp;getDetexer()</pre>
+<h4>getTextCleaner</h4>
+<pre>public&nbsp;<a href="../../../../ca/uqac/lif/textidote/cleaning/TextCleaner.html" title="class in ca.uqac.lif.textidote.cleaning">TextCleaner</a>&nbsp;getTextCleaner()</pre>
 <div class="block"><p>Gets the instance of detexer used by this linter.</p></div>
 <dl>
 <dt><span class="returnLabel">Returns:</span></dt>
@@ -401,8 +401,8 @@ <h4>getDetexer</h4>
 </div>
 <div class="subNav">
 <ul class="navList">
-<li><a href="../../../../ca/uqac/lif/textidote/Detexer.html" title="class in ca.uqac.lif.textidote"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
-<li><a href="../../../../ca/uqac/lif/textidote/Main.html" title="class in ca.uqac.lif.textidote"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
+<li><a href="../../../../ca/uqac/lif/textidote/AdviceRenderer.html" title="class in ca.uqac.lif.textidote"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
+<li><a href="../../../../ca/uqac/lif/textidote/LinterException.html" title="class in ca.uqac.lif.textidote"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
 </ul>
 <ul class="navList">
 <li><a href="../../../../index.html?ca/uqac/lif/textidote/Linter.html" target="_top">Frames</a></li>