From d089fb2dc14684330d30d8854aaed67d077118fb Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Sylvain=20Hall=C3=A9?= Date: Mon, 2 Jul 2018 18:51:13 -0400 Subject: [PATCH] Fixed Javadoc warning --- .../Core/src/ca/uqac/lif/textidote/Main.java | 3 +- docs/javadoc/allclasses-frame.html | 4 +- docs/javadoc/allclasses-noframe.html | 4 +- .../javadoc/ca/uqac/lif/textidote/Advice.html | 4 +- .../ca/uqac/lif/textidote/AdviceRenderer.html | 4 +- .../javadoc/ca/uqac/lif/textidote/Linter.html | 4 +- .../uqac/lif/textidote/LinterException.html | 4 +- docs/javadoc/ca/uqac/lif/textidote/Main.html | 8 +-- docs/javadoc/ca/uqac/lif/textidote/Rule.html | 4 +- .../lif/textidote/as/AnnotatedString.html | 6 +-- .../ca/uqac/lif/textidote/as/Match.html | 4 +- .../lif/textidote/as/Position.Nowhere.html | 4 +- .../ca/uqac/lif/textidote/as/Position.html | 4 +- .../ca/uqac/lif/textidote/as/Range.html | 4 +- .../as/class-use/AnnotatedString.html | 4 +- .../lif/textidote/as/class-use/Match.html | 4 +- .../as/class-use/Position.Nowhere.html | 4 +- .../lif/textidote/as/class-use/Position.html | 4 +- .../lif/textidote/as/class-use/Range.html | 8 +-- .../uqac/lif/textidote/as/package-frame.html | 4 +- .../lif/textidote/as/package-summary.html | 4 +- .../uqac/lif/textidote/as/package-tree.html | 4 +- .../ca/uqac/lif/textidote/as/package-use.html | 4 +- .../uqac/lif/textidote/class-use/Advice.html | 4 +- .../textidote/class-use/AdviceRenderer.html | 6 +-- .../uqac/lif/textidote/class-use/Linter.html | 4 +- .../textidote/class-use/LinterException.html | 4 +- .../ca/uqac/lif/textidote/class-use/Main.html | 4 +- .../ca/uqac/lif/textidote/class-use/Rule.html | 4 +- .../textidote/cleaning/CompositeCleaner.html | 4 +- .../cleaning/ReplacementCleaner.html | 4 +- .../lif/textidote/cleaning/TextCleaner.html | 4 +- .../cleaning/TextCleanerException.html | 4 +- .../cleaning/class-use/CompositeCleaner.html | 4 +- .../class-use/ReplacementCleaner.html | 4 +- .../cleaning/class-use/TextCleaner.html | 4 +- .../class-use/TextCleanerException.html | 4 +- .../cleaning/latex/LatexCleaner.html | 4 +- .../latex/class-use/LatexCleaner.html | 4 +- .../cleaning/latex/package-frame.html | 4 +- .../cleaning/latex/package-summary.html | 4 +- .../cleaning/latex/package-tree.html | 4 +- .../textidote/cleaning/latex/package-use.html | 4 +- .../lif/textidote/cleaning/package-frame.html | 4 +- .../textidote/cleaning/package-summary.html | 4 +- .../lif/textidote/cleaning/package-tree.html | 4 +- .../lif/textidote/cleaning/package-use.html | 4 +- .../ca/uqac/lif/textidote/package-frame.html | 4 +- .../uqac/lif/textidote/package-summary.html | 4 +- .../ca/uqac/lif/textidote/package-tree.html | 4 +- .../ca/uqac/lif/textidote/package-use.html | 4 +- .../textidote/render/AnsiAdviceRenderer.html | 50 ++++++++++++++++--- .../textidote/render/HtmlAdviceRenderer.html | 4 +- .../render/class-use/AnsiAdviceRenderer.html | 4 +- .../render/class-use/HtmlAdviceRenderer.html | 4 +- .../lif/textidote/render/package-frame.html | 4 +- .../lif/textidote/render/package-summary.html | 6 +-- .../lif/textidote/render/package-tree.html | 4 +- .../lif/textidote/render/package-use.html | 4 +- .../lif/textidote/rules/CheckCaptions.html | 4 +- .../lif/textidote/rules/CheckFigurePaths.html | 4 +- .../rules/CheckFigureReferences.html | 4 +- .../CheckLanguage.CheckLanguageSpecific.html | 4 +- ...Language.UnsupportedLanguageException.html | 4 +- .../lif/textidote/rules/CheckLanguage.html | 4 +- .../lif/textidote/rules/CheckNoBreak.html | 4 +- .../textidote/rules/CheckSubsectionSize.html | 4 +- .../lif/textidote/rules/CheckSubsections.html | 4 +- .../lif/textidote/rules/LanguageFactory.html | 4 +- .../uqac/lif/textidote/rules/RegexRule.html | 4 +- .../rules/class-use/CheckCaptions.html | 4 +- .../rules/class-use/CheckFigurePaths.html | 4 +- .../class-use/CheckFigureReferences.html | 4 +- .../CheckLanguage.CheckLanguageSpecific.html | 4 +- ...Language.UnsupportedLanguageException.html | 4 +- .../rules/class-use/CheckLanguage.html | 4 +- .../rules/class-use/CheckNoBreak.html | 4 +- .../rules/class-use/CheckSubsectionSize.html | 4 +- .../rules/class-use/CheckSubsections.html | 4 +- .../rules/class-use/LanguageFactory.html | 4 +- .../textidote/rules/class-use/RegexRule.html | 4 +- .../lif/textidote/rules/package-frame.html | 4 +- .../lif/textidote/rules/package-summary.html | 4 +- .../lif/textidote/rules/package-tree.html | 4 +- .../uqac/lif/textidote/rules/package-use.html | 4 +- .../ca/uqac/lif/util/AnsiPrinter.Color.html | 4 +- .../javadoc/ca/uqac/lif/util/AnsiPrinter.html | 4 +- .../ca/uqac/lif/util/NullPrintStream.html | 4 +- .../lif/util/class-use/AnsiPrinter.Color.html | 4 +- .../uqac/lif/util/class-use/AnsiPrinter.html | 8 +-- .../lif/util/class-use/NullPrintStream.html | 4 +- .../ca/uqac/lif/util/package-frame.html | 4 +- .../ca/uqac/lif/util/package-summary.html | 4 +- .../ca/uqac/lif/util/package-tree.html | 4 +- .../javadoc/ca/uqac/lif/util/package-use.html | 4 +- docs/javadoc/constant-values.html | 4 +- docs/javadoc/deprecated-list.html | 4 +- docs/javadoc/help-doc.html | 4 +- docs/javadoc/index-all.html | 28 +++++++---- docs/javadoc/index.html | 2 +- docs/javadoc/overview-frame.html | 4 +- docs/javadoc/overview-summary.html | 4 +- docs/javadoc/overview-tree.html | 4 +- docs/javadoc/serialized-form.html | 4 +- 104 files changed, 275 insertions(+), 226 deletions(-) diff --git a/Source/Core/src/ca/uqac/lif/textidote/Main.java b/Source/Core/src/ca/uqac/lif/textidote/Main.java index 26e8fff2..f5f6e2c9 100644 --- a/Source/Core/src/ca/uqac/lif/textidote/Main.java +++ b/Source/Core/src/ca/uqac/lif/textidote/Main.java @@ -80,7 +80,8 @@ public class Main protected static final String ASPELL_DICT_FILENAME = ".aspell.XX.pws"; /** - * Main method. This method simply calls the static method {@link #mainLoop()}, + * Main method. This method simply calls the static method + * {@link #main(String[]) mainLoop()}, * and exits with the return value of that method. The reason for this is * is that we can test the main loop, and the test is not interrupted * by calls to {@code System.exit}. diff --git a/docs/javadoc/allclasses-frame.html b/docs/javadoc/allclasses-frame.html index 2b0d61ef..30b56b06 100644 --- a/docs/javadoc/allclasses-frame.html +++ b/docs/javadoc/allclasses-frame.html @@ -2,10 +2,10 @@ - + All Classes (TeXtidote Documentation) - + diff --git a/docs/javadoc/allclasses-noframe.html b/docs/javadoc/allclasses-noframe.html index b425fd24..c131f134 100644 --- a/docs/javadoc/allclasses-noframe.html +++ b/docs/javadoc/allclasses-noframe.html @@ -2,10 +2,10 @@ - + All Classes (TeXtidote Documentation) - + diff --git a/docs/javadoc/ca/uqac/lif/textidote/Advice.html b/docs/javadoc/ca/uqac/lif/textidote/Advice.html index f71e0859..c8113643 100644 --- a/docs/javadoc/ca/uqac/lif/textidote/Advice.html +++ b/docs/javadoc/ca/uqac/lif/textidote/Advice.html @@ -2,10 +2,10 @@ - + Advice (TeXtidote Documentation) - + diff --git a/docs/javadoc/ca/uqac/lif/textidote/AdviceRenderer.html b/docs/javadoc/ca/uqac/lif/textidote/AdviceRenderer.html index f5a0ff33..ec0b717e 100644 --- a/docs/javadoc/ca/uqac/lif/textidote/AdviceRenderer.html +++ b/docs/javadoc/ca/uqac/lif/textidote/AdviceRenderer.html @@ -2,10 +2,10 @@ - + AdviceRenderer (TeXtidote Documentation) - + diff --git a/docs/javadoc/ca/uqac/lif/textidote/Linter.html b/docs/javadoc/ca/uqac/lif/textidote/Linter.html index 4a8a67c2..0a50c1b6 100644 --- a/docs/javadoc/ca/uqac/lif/textidote/Linter.html +++ b/docs/javadoc/ca/uqac/lif/textidote/Linter.html @@ -2,10 +2,10 @@ - + Linter (TeXtidote Documentation) - + diff --git a/docs/javadoc/ca/uqac/lif/textidote/LinterException.html b/docs/javadoc/ca/uqac/lif/textidote/LinterException.html index b7ac1990..2e015d34 100644 --- a/docs/javadoc/ca/uqac/lif/textidote/LinterException.html +++ b/docs/javadoc/ca/uqac/lif/textidote/LinterException.html @@ -2,10 +2,10 @@ - + LinterException (TeXtidote Documentation) - + diff --git a/docs/javadoc/ca/uqac/lif/textidote/Main.html b/docs/javadoc/ca/uqac/lif/textidote/Main.html index bff880f4..1a57ae8c 100644 --- a/docs/javadoc/ca/uqac/lif/textidote/Main.html +++ b/docs/javadoc/ca/uqac/lif/textidote/Main.html @@ -2,10 +2,10 @@ - + Main (TeXtidote Documentation) - + @@ -190,7 +190,7 @@

Method Summary

static void main(java.lang.String[] args) -
Main method
+
Main method.
@@ -338,7 +338,7 @@

Method Detail

main

public static void main(java.lang.String[] args)
                  throws java.io.IOException
-

Main method

+

Main method. This method simply calls the static method mainLoop(), and exits with the return value of that method. The reason for this is is that we can test the main loop, and the test is not interrupted by calls to System.exit.

Parameters:
args - Command-line arguments
diff --git a/docs/javadoc/ca/uqac/lif/textidote/Rule.html b/docs/javadoc/ca/uqac/lif/textidote/Rule.html index 1fef9af2..40136b85 100644 --- a/docs/javadoc/ca/uqac/lif/textidote/Rule.html +++ b/docs/javadoc/ca/uqac/lif/textidote/Rule.html @@ -2,10 +2,10 @@ - + Rule (TeXtidote Documentation) - + diff --git a/docs/javadoc/ca/uqac/lif/textidote/as/AnnotatedString.html b/docs/javadoc/ca/uqac/lif/textidote/as/AnnotatedString.html index 79fd7f4e..9350f3f6 100644 --- a/docs/javadoc/ca/uqac/lif/textidote/as/AnnotatedString.html +++ b/docs/javadoc/ca/uqac/lif/textidote/as/AnnotatedString.html @@ -2,10 +2,10 @@ - + AnnotatedString (TeXtidote Documentation) - + @@ -904,7 +904,7 @@

getPosition

Parameters:
nb_chars - The number of characters from the beginning of the string
Returns:
-
The position, or null if nb_chars lies beyond the string boundaries
+
The position; you get Position.NOWHERE if nb_chars lies beyond the string boundaries
diff --git a/docs/javadoc/ca/uqac/lif/textidote/as/Match.html b/docs/javadoc/ca/uqac/lif/textidote/as/Match.html index a3013fb3..60f71e7a 100644 --- a/docs/javadoc/ca/uqac/lif/textidote/as/Match.html +++ b/docs/javadoc/ca/uqac/lif/textidote/as/Match.html @@ -2,10 +2,10 @@ - + Match (TeXtidote Documentation) - + diff --git a/docs/javadoc/ca/uqac/lif/textidote/as/Position.Nowhere.html b/docs/javadoc/ca/uqac/lif/textidote/as/Position.Nowhere.html index c5446ece..96ff79dc 100644 --- a/docs/javadoc/ca/uqac/lif/textidote/as/Position.Nowhere.html +++ b/docs/javadoc/ca/uqac/lif/textidote/as/Position.Nowhere.html @@ -2,10 +2,10 @@ - + Position.Nowhere (TeXtidote Documentation) - + diff --git a/docs/javadoc/ca/uqac/lif/textidote/as/Position.html b/docs/javadoc/ca/uqac/lif/textidote/as/Position.html index 523ede3e..4385e134 100644 --- a/docs/javadoc/ca/uqac/lif/textidote/as/Position.html +++ b/docs/javadoc/ca/uqac/lif/textidote/as/Position.html @@ -2,10 +2,10 @@ - + Position (TeXtidote Documentation) - + diff --git a/docs/javadoc/ca/uqac/lif/textidote/as/Range.html b/docs/javadoc/ca/uqac/lif/textidote/as/Range.html index f64752aa..7b0811f9 100644 --- a/docs/javadoc/ca/uqac/lif/textidote/as/Range.html +++ b/docs/javadoc/ca/uqac/lif/textidote/as/Range.html @@ -2,10 +2,10 @@ - + Range (TeXtidote Documentation) - + diff --git a/docs/javadoc/ca/uqac/lif/textidote/as/class-use/AnnotatedString.html b/docs/javadoc/ca/uqac/lif/textidote/as/class-use/AnnotatedString.html index fd3ba13e..5ac56380 100644 --- a/docs/javadoc/ca/uqac/lif/textidote/as/class-use/AnnotatedString.html +++ b/docs/javadoc/ca/uqac/lif/textidote/as/class-use/AnnotatedString.html @@ -2,10 +2,10 @@ - + Uses of Class ca.uqac.lif.textidote.as.AnnotatedString (TeXtidote Documentation) - + diff --git a/docs/javadoc/ca/uqac/lif/textidote/as/class-use/Match.html b/docs/javadoc/ca/uqac/lif/textidote/as/class-use/Match.html index 2cf38c03..d1897024 100644 --- a/docs/javadoc/ca/uqac/lif/textidote/as/class-use/Match.html +++ b/docs/javadoc/ca/uqac/lif/textidote/as/class-use/Match.html @@ -2,10 +2,10 @@ - + Uses of Class ca.uqac.lif.textidote.as.Match (TeXtidote Documentation) - + diff --git a/docs/javadoc/ca/uqac/lif/textidote/as/class-use/Position.Nowhere.html b/docs/javadoc/ca/uqac/lif/textidote/as/class-use/Position.Nowhere.html index 1941110f..da09a720 100644 --- a/docs/javadoc/ca/uqac/lif/textidote/as/class-use/Position.Nowhere.html +++ b/docs/javadoc/ca/uqac/lif/textidote/as/class-use/Position.Nowhere.html @@ -2,10 +2,10 @@ - + Uses of Class ca.uqac.lif.textidote.as.Position.Nowhere (TeXtidote Documentation) - + diff --git a/docs/javadoc/ca/uqac/lif/textidote/as/class-use/Position.html b/docs/javadoc/ca/uqac/lif/textidote/as/class-use/Position.html index b3f212a8..84dc02f6 100644 --- a/docs/javadoc/ca/uqac/lif/textidote/as/class-use/Position.html +++ b/docs/javadoc/ca/uqac/lif/textidote/as/class-use/Position.html @@ -2,10 +2,10 @@ - + Uses of Class ca.uqac.lif.textidote.as.Position (TeXtidote Documentation) - + diff --git a/docs/javadoc/ca/uqac/lif/textidote/as/class-use/Range.html b/docs/javadoc/ca/uqac/lif/textidote/as/class-use/Range.html index dd058e92..733ae3d6 100644 --- a/docs/javadoc/ca/uqac/lif/textidote/as/class-use/Range.html +++ b/docs/javadoc/ca/uqac/lif/textidote/as/class-use/Range.html @@ -2,10 +2,10 @@ - + Uses of Class ca.uqac.lif.textidote.as.Range (TeXtidote Documentation) - + @@ -334,7 +334,9 @@

Uses of protected void AnsiAdviceRenderer.renderExcerpt(java.lang.String line, - Range range)  + Range range) +
Renders a line of text and “highlights” a portion of it.
+ diff --git a/docs/javadoc/ca/uqac/lif/textidote/as/package-frame.html b/docs/javadoc/ca/uqac/lif/textidote/as/package-frame.html index f3fd6a63..de412715 100644 --- a/docs/javadoc/ca/uqac/lif/textidote/as/package-frame.html +++ b/docs/javadoc/ca/uqac/lif/textidote/as/package-frame.html @@ -2,10 +2,10 @@ - + ca.uqac.lif.textidote.as (TeXtidote Documentation) - + diff --git a/docs/javadoc/ca/uqac/lif/textidote/as/package-summary.html b/docs/javadoc/ca/uqac/lif/textidote/as/package-summary.html index 8260e0af..75a90399 100644 --- a/docs/javadoc/ca/uqac/lif/textidote/as/package-summary.html +++ b/docs/javadoc/ca/uqac/lif/textidote/as/package-summary.html @@ -2,10 +2,10 @@ - + ca.uqac.lif.textidote.as (TeXtidote Documentation) - + diff --git a/docs/javadoc/ca/uqac/lif/textidote/as/package-tree.html b/docs/javadoc/ca/uqac/lif/textidote/as/package-tree.html index 9e1c373f..6742b335 100644 --- a/docs/javadoc/ca/uqac/lif/textidote/as/package-tree.html +++ b/docs/javadoc/ca/uqac/lif/textidote/as/package-tree.html @@ -2,10 +2,10 @@ - + ca.uqac.lif.textidote.as Class Hierarchy (TeXtidote Documentation) - + diff --git a/docs/javadoc/ca/uqac/lif/textidote/as/package-use.html b/docs/javadoc/ca/uqac/lif/textidote/as/package-use.html index a7770885..aa936ae5 100644 --- a/docs/javadoc/ca/uqac/lif/textidote/as/package-use.html +++ b/docs/javadoc/ca/uqac/lif/textidote/as/package-use.html @@ -2,10 +2,10 @@ - + Uses of Package ca.uqac.lif.textidote.as (TeXtidote Documentation) - + diff --git a/docs/javadoc/ca/uqac/lif/textidote/class-use/Advice.html b/docs/javadoc/ca/uqac/lif/textidote/class-use/Advice.html index c47534bc..76598650 100644 --- a/docs/javadoc/ca/uqac/lif/textidote/class-use/Advice.html +++ b/docs/javadoc/ca/uqac/lif/textidote/class-use/Advice.html @@ -2,10 +2,10 @@ - + Uses of Class ca.uqac.lif.textidote.Advice (TeXtidote Documentation) - + diff --git a/docs/javadoc/ca/uqac/lif/textidote/class-use/AdviceRenderer.html b/docs/javadoc/ca/uqac/lif/textidote/class-use/AdviceRenderer.html index c83a3b94..408c5116 100644 --- a/docs/javadoc/ca/uqac/lif/textidote/class-use/AdviceRenderer.html +++ b/docs/javadoc/ca/uqac/lif/textidote/class-use/AdviceRenderer.html @@ -2,10 +2,10 @@ - + Uses of Class ca.uqac.lif.textidote.AdviceRenderer (TeXtidote Documentation) - + @@ -106,7 +106,7 @@

Uses of class  AnsiAdviceRenderer -
Renders a list of advice to a terminal (such as stdin), using colored output.
+
Renders a list of advice to a terminal (such as stdin), using colored output.
diff --git a/docs/javadoc/ca/uqac/lif/textidote/class-use/Linter.html b/docs/javadoc/ca/uqac/lif/textidote/class-use/Linter.html index 629b0daa..3c27a38e 100644 --- a/docs/javadoc/ca/uqac/lif/textidote/class-use/Linter.html +++ b/docs/javadoc/ca/uqac/lif/textidote/class-use/Linter.html @@ -2,10 +2,10 @@ - + Uses of Class ca.uqac.lif.textidote.Linter (TeXtidote Documentation) - + diff --git a/docs/javadoc/ca/uqac/lif/textidote/class-use/LinterException.html b/docs/javadoc/ca/uqac/lif/textidote/class-use/LinterException.html index 82231827..5960d653 100644 --- a/docs/javadoc/ca/uqac/lif/textidote/class-use/LinterException.html +++ b/docs/javadoc/ca/uqac/lif/textidote/class-use/LinterException.html @@ -2,10 +2,10 @@ - + Uses of Class ca.uqac.lif.textidote.LinterException (TeXtidote Documentation) - + diff --git a/docs/javadoc/ca/uqac/lif/textidote/class-use/Main.html b/docs/javadoc/ca/uqac/lif/textidote/class-use/Main.html index be8a7a9f..f568ebb3 100644 --- a/docs/javadoc/ca/uqac/lif/textidote/class-use/Main.html +++ b/docs/javadoc/ca/uqac/lif/textidote/class-use/Main.html @@ -2,10 +2,10 @@ - + Uses of Class ca.uqac.lif.textidote.Main (TeXtidote Documentation) - + diff --git a/docs/javadoc/ca/uqac/lif/textidote/class-use/Rule.html b/docs/javadoc/ca/uqac/lif/textidote/class-use/Rule.html index 7ed613fc..29c96cf9 100644 --- a/docs/javadoc/ca/uqac/lif/textidote/class-use/Rule.html +++ b/docs/javadoc/ca/uqac/lif/textidote/class-use/Rule.html @@ -2,10 +2,10 @@ - + Uses of Class ca.uqac.lif.textidote.Rule (TeXtidote Documentation) - + diff --git a/docs/javadoc/ca/uqac/lif/textidote/cleaning/CompositeCleaner.html b/docs/javadoc/ca/uqac/lif/textidote/cleaning/CompositeCleaner.html index fbf4ca92..32eabf07 100644 --- a/docs/javadoc/ca/uqac/lif/textidote/cleaning/CompositeCleaner.html +++ b/docs/javadoc/ca/uqac/lif/textidote/cleaning/CompositeCleaner.html @@ -2,10 +2,10 @@ - + CompositeCleaner (TeXtidote Documentation) - + diff --git a/docs/javadoc/ca/uqac/lif/textidote/cleaning/ReplacementCleaner.html b/docs/javadoc/ca/uqac/lif/textidote/cleaning/ReplacementCleaner.html index 8ca2678c..4c11cf8d 100644 --- a/docs/javadoc/ca/uqac/lif/textidote/cleaning/ReplacementCleaner.html +++ b/docs/javadoc/ca/uqac/lif/textidote/cleaning/ReplacementCleaner.html @@ -2,10 +2,10 @@ - + ReplacementCleaner (TeXtidote Documentation) - + diff --git a/docs/javadoc/ca/uqac/lif/textidote/cleaning/TextCleaner.html b/docs/javadoc/ca/uqac/lif/textidote/cleaning/TextCleaner.html index 042c3e72..30051c3b 100644 --- a/docs/javadoc/ca/uqac/lif/textidote/cleaning/TextCleaner.html +++ b/docs/javadoc/ca/uqac/lif/textidote/cleaning/TextCleaner.html @@ -2,10 +2,10 @@ - + TextCleaner (TeXtidote Documentation) - + diff --git a/docs/javadoc/ca/uqac/lif/textidote/cleaning/TextCleanerException.html b/docs/javadoc/ca/uqac/lif/textidote/cleaning/TextCleanerException.html index b9248ded..aa2002fc 100644 --- a/docs/javadoc/ca/uqac/lif/textidote/cleaning/TextCleanerException.html +++ b/docs/javadoc/ca/uqac/lif/textidote/cleaning/TextCleanerException.html @@ -2,10 +2,10 @@ - + TextCleanerException (TeXtidote Documentation) - + diff --git a/docs/javadoc/ca/uqac/lif/textidote/cleaning/class-use/CompositeCleaner.html b/docs/javadoc/ca/uqac/lif/textidote/cleaning/class-use/CompositeCleaner.html index 88cdeb29..6bdc0e08 100644 --- a/docs/javadoc/ca/uqac/lif/textidote/cleaning/class-use/CompositeCleaner.html +++ b/docs/javadoc/ca/uqac/lif/textidote/cleaning/class-use/CompositeCleaner.html @@ -2,10 +2,10 @@ - + Uses of Class ca.uqac.lif.textidote.cleaning.CompositeCleaner (TeXtidote Documentation) - + diff --git a/docs/javadoc/ca/uqac/lif/textidote/cleaning/class-use/ReplacementCleaner.html b/docs/javadoc/ca/uqac/lif/textidote/cleaning/class-use/ReplacementCleaner.html index b0194751..5dccbe9d 100644 --- a/docs/javadoc/ca/uqac/lif/textidote/cleaning/class-use/ReplacementCleaner.html +++ b/docs/javadoc/ca/uqac/lif/textidote/cleaning/class-use/ReplacementCleaner.html @@ -2,10 +2,10 @@ - + Uses of Class ca.uqac.lif.textidote.cleaning.ReplacementCleaner (TeXtidote Documentation) - + diff --git a/docs/javadoc/ca/uqac/lif/textidote/cleaning/class-use/TextCleaner.html b/docs/javadoc/ca/uqac/lif/textidote/cleaning/class-use/TextCleaner.html index a906baad..c250db5d 100644 --- a/docs/javadoc/ca/uqac/lif/textidote/cleaning/class-use/TextCleaner.html +++ b/docs/javadoc/ca/uqac/lif/textidote/cleaning/class-use/TextCleaner.html @@ -2,10 +2,10 @@ - + Uses of Class ca.uqac.lif.textidote.cleaning.TextCleaner (TeXtidote Documentation) - + diff --git a/docs/javadoc/ca/uqac/lif/textidote/cleaning/class-use/TextCleanerException.html b/docs/javadoc/ca/uqac/lif/textidote/cleaning/class-use/TextCleanerException.html index 1813b903..72d887de 100644 --- a/docs/javadoc/ca/uqac/lif/textidote/cleaning/class-use/TextCleanerException.html +++ b/docs/javadoc/ca/uqac/lif/textidote/cleaning/class-use/TextCleanerException.html @@ -2,10 +2,10 @@ - + Uses of Class ca.uqac.lif.textidote.cleaning.TextCleanerException (TeXtidote Documentation) - + diff --git a/docs/javadoc/ca/uqac/lif/textidote/cleaning/latex/LatexCleaner.html b/docs/javadoc/ca/uqac/lif/textidote/cleaning/latex/LatexCleaner.html index c514b889..4aaf4907 100644 --- a/docs/javadoc/ca/uqac/lif/textidote/cleaning/latex/LatexCleaner.html +++ b/docs/javadoc/ca/uqac/lif/textidote/cleaning/latex/LatexCleaner.html @@ -2,10 +2,10 @@ - + LatexCleaner (TeXtidote Documentation) - + diff --git a/docs/javadoc/ca/uqac/lif/textidote/cleaning/latex/class-use/LatexCleaner.html b/docs/javadoc/ca/uqac/lif/textidote/cleaning/latex/class-use/LatexCleaner.html index 36cede85..256b4729 100644 --- a/docs/javadoc/ca/uqac/lif/textidote/cleaning/latex/class-use/LatexCleaner.html +++ b/docs/javadoc/ca/uqac/lif/textidote/cleaning/latex/class-use/LatexCleaner.html @@ -2,10 +2,10 @@ - + Uses of Class ca.uqac.lif.textidote.cleaning.latex.LatexCleaner (TeXtidote Documentation) - + diff --git a/docs/javadoc/ca/uqac/lif/textidote/cleaning/latex/package-frame.html b/docs/javadoc/ca/uqac/lif/textidote/cleaning/latex/package-frame.html index 893e1a1f..90c6d3f3 100644 --- a/docs/javadoc/ca/uqac/lif/textidote/cleaning/latex/package-frame.html +++ b/docs/javadoc/ca/uqac/lif/textidote/cleaning/latex/package-frame.html @@ -2,10 +2,10 @@ - + ca.uqac.lif.textidote.cleaning.latex (TeXtidote Documentation) - + diff --git a/docs/javadoc/ca/uqac/lif/textidote/cleaning/latex/package-summary.html b/docs/javadoc/ca/uqac/lif/textidote/cleaning/latex/package-summary.html index 27d10020..99445513 100644 --- a/docs/javadoc/ca/uqac/lif/textidote/cleaning/latex/package-summary.html +++ b/docs/javadoc/ca/uqac/lif/textidote/cleaning/latex/package-summary.html @@ -2,10 +2,10 @@ - + ca.uqac.lif.textidote.cleaning.latex (TeXtidote Documentation) - + diff --git a/docs/javadoc/ca/uqac/lif/textidote/cleaning/latex/package-tree.html b/docs/javadoc/ca/uqac/lif/textidote/cleaning/latex/package-tree.html index 372f00ba..e46ab758 100644 --- a/docs/javadoc/ca/uqac/lif/textidote/cleaning/latex/package-tree.html +++ b/docs/javadoc/ca/uqac/lif/textidote/cleaning/latex/package-tree.html @@ -2,10 +2,10 @@ - + ca.uqac.lif.textidote.cleaning.latex Class Hierarchy (TeXtidote Documentation) - + diff --git a/docs/javadoc/ca/uqac/lif/textidote/cleaning/latex/package-use.html b/docs/javadoc/ca/uqac/lif/textidote/cleaning/latex/package-use.html index 6b35ed10..d2fb17c3 100644 --- a/docs/javadoc/ca/uqac/lif/textidote/cleaning/latex/package-use.html +++ b/docs/javadoc/ca/uqac/lif/textidote/cleaning/latex/package-use.html @@ -2,10 +2,10 @@ - + Uses of Package ca.uqac.lif.textidote.cleaning.latex (TeXtidote Documentation) - + diff --git a/docs/javadoc/ca/uqac/lif/textidote/cleaning/package-frame.html b/docs/javadoc/ca/uqac/lif/textidote/cleaning/package-frame.html index 209034b4..a23b77e3 100644 --- a/docs/javadoc/ca/uqac/lif/textidote/cleaning/package-frame.html +++ b/docs/javadoc/ca/uqac/lif/textidote/cleaning/package-frame.html @@ -2,10 +2,10 @@ - + ca.uqac.lif.textidote.cleaning (TeXtidote Documentation) - + diff --git a/docs/javadoc/ca/uqac/lif/textidote/cleaning/package-summary.html b/docs/javadoc/ca/uqac/lif/textidote/cleaning/package-summary.html index 906352d4..e64df5f7 100644 --- a/docs/javadoc/ca/uqac/lif/textidote/cleaning/package-summary.html +++ b/docs/javadoc/ca/uqac/lif/textidote/cleaning/package-summary.html @@ -2,10 +2,10 @@ - + ca.uqac.lif.textidote.cleaning (TeXtidote Documentation) - + diff --git a/docs/javadoc/ca/uqac/lif/textidote/cleaning/package-tree.html b/docs/javadoc/ca/uqac/lif/textidote/cleaning/package-tree.html index b5be478a..5acd17bf 100644 --- a/docs/javadoc/ca/uqac/lif/textidote/cleaning/package-tree.html +++ b/docs/javadoc/ca/uqac/lif/textidote/cleaning/package-tree.html @@ -2,10 +2,10 @@ - + ca.uqac.lif.textidote.cleaning Class Hierarchy (TeXtidote Documentation) - + diff --git a/docs/javadoc/ca/uqac/lif/textidote/cleaning/package-use.html b/docs/javadoc/ca/uqac/lif/textidote/cleaning/package-use.html index 80632864..f8122077 100644 --- a/docs/javadoc/ca/uqac/lif/textidote/cleaning/package-use.html +++ b/docs/javadoc/ca/uqac/lif/textidote/cleaning/package-use.html @@ -2,10 +2,10 @@ - + Uses of Package ca.uqac.lif.textidote.cleaning (TeXtidote Documentation) - + diff --git a/docs/javadoc/ca/uqac/lif/textidote/package-frame.html b/docs/javadoc/ca/uqac/lif/textidote/package-frame.html index 7e9269e5..0abc2275 100644 --- a/docs/javadoc/ca/uqac/lif/textidote/package-frame.html +++ b/docs/javadoc/ca/uqac/lif/textidote/package-frame.html @@ -2,10 +2,10 @@ - + ca.uqac.lif.textidote (TeXtidote Documentation) - + diff --git a/docs/javadoc/ca/uqac/lif/textidote/package-summary.html b/docs/javadoc/ca/uqac/lif/textidote/package-summary.html index cb703178..3a41ec83 100644 --- a/docs/javadoc/ca/uqac/lif/textidote/package-summary.html +++ b/docs/javadoc/ca/uqac/lif/textidote/package-summary.html @@ -2,10 +2,10 @@ - + ca.uqac.lif.textidote (TeXtidote Documentation) - + diff --git a/docs/javadoc/ca/uqac/lif/textidote/package-tree.html b/docs/javadoc/ca/uqac/lif/textidote/package-tree.html index 5f1d2272..74774710 100644 --- a/docs/javadoc/ca/uqac/lif/textidote/package-tree.html +++ b/docs/javadoc/ca/uqac/lif/textidote/package-tree.html @@ -2,10 +2,10 @@ - + ca.uqac.lif.textidote Class Hierarchy (TeXtidote Documentation) - + diff --git a/docs/javadoc/ca/uqac/lif/textidote/package-use.html b/docs/javadoc/ca/uqac/lif/textidote/package-use.html index f24d213f..292deada 100644 --- a/docs/javadoc/ca/uqac/lif/textidote/package-use.html +++ b/docs/javadoc/ca/uqac/lif/textidote/package-use.html @@ -2,10 +2,10 @@ - + Uses of Package ca.uqac.lif.textidote (TeXtidote Documentation) - + diff --git a/docs/javadoc/ca/uqac/lif/textidote/render/AnsiAdviceRenderer.html b/docs/javadoc/ca/uqac/lif/textidote/render/AnsiAdviceRenderer.html index f9144ce7..ce83aca7 100644 --- a/docs/javadoc/ca/uqac/lif/textidote/render/AnsiAdviceRenderer.html +++ b/docs/javadoc/ca/uqac/lif/textidote/render/AnsiAdviceRenderer.html @@ -2,10 +2,10 @@ - + AnsiAdviceRenderer (TeXtidote Documentation) - + @@ -117,7 +117,7 @@

Class AnsiAdviceRenderer


public class AnsiAdviceRenderer
 extends AdviceRenderer
-

Renders a list of advice to a terminal (such as stdin), using colored output.

+

Renders a list of advice to a terminal (such as stdin), using colored output.

@@ -144,7 +144,9 @@

Field Summary

protected int -m_terminalLineWidth  +m_terminalLineWidth +
The width of the line in the terminal (in number of characters)
+ @@ -297,6 +313,12 @@

render

renderExcerpt

protected void renderExcerpt(java.lang.String line,
                              Range range)
+

Renders a line of text and “highlights” a portion of it. The highlight here is simulated with a series of “^” characters, like this: 

 the quick brown fox jumps over the lazy dog  ^^^^^^^^^^^^^^^

+
+
Parameters:
+
line - The line of text
+
range - The range to highlight
+
@@ -306,6 +328,11 @@

renderExcerpt

  • printSpaces

    protected void printSpaces(int n)
    +

    Prints some spaces

    +
    +
    Parameters:
    +
    n - The number of spaces to print
    +
    •  @@ -317,6 +344,13 @@

    wrap

    protected void wrap(java.lang.String message,
                     java.lang.String indent,
                     int start_pos)
    +

    Prints a sequence of words, using word wrapping and indenting each new line

    +
    +
    Parameters:
    +
    message - The sequence of words to print
    +
    indent - The indent (a sequence of spaces) to append at the beginning of each new line
    +
    start_pos - The start position on the first line (set to greater than 0 to append text to an existing line)
    +
    diff --git a/docs/javadoc/ca/uqac/lif/textidote/render/HtmlAdviceRenderer.html b/docs/javadoc/ca/uqac/lif/textidote/render/HtmlAdviceRenderer.html index bf3ebd3e..8df74a54 100644 --- a/docs/javadoc/ca/uqac/lif/textidote/render/HtmlAdviceRenderer.html +++ b/docs/javadoc/ca/uqac/lif/textidote/render/HtmlAdviceRenderer.html @@ -2,10 +2,10 @@ - + HtmlAdviceRenderer (TeXtidote Documentation) - + diff --git a/docs/javadoc/ca/uqac/lif/textidote/render/class-use/AnsiAdviceRenderer.html b/docs/javadoc/ca/uqac/lif/textidote/render/class-use/AnsiAdviceRenderer.html index 1bef60f4..a1bbef9a 100644 --- a/docs/javadoc/ca/uqac/lif/textidote/render/class-use/AnsiAdviceRenderer.html +++ b/docs/javadoc/ca/uqac/lif/textidote/render/class-use/AnsiAdviceRenderer.html @@ -2,10 +2,10 @@ - + Uses of Class ca.uqac.lif.textidote.render.AnsiAdviceRenderer (TeXtidote Documentation) - + diff --git a/docs/javadoc/ca/uqac/lif/textidote/render/class-use/HtmlAdviceRenderer.html b/docs/javadoc/ca/uqac/lif/textidote/render/class-use/HtmlAdviceRenderer.html index a0ac392a..cfc5e861 100644 --- a/docs/javadoc/ca/uqac/lif/textidote/render/class-use/HtmlAdviceRenderer.html +++ b/docs/javadoc/ca/uqac/lif/textidote/render/class-use/HtmlAdviceRenderer.html @@ -2,10 +2,10 @@ - + Uses of Class ca.uqac.lif.textidote.render.HtmlAdviceRenderer (TeXtidote Documentation) - + diff --git a/docs/javadoc/ca/uqac/lif/textidote/render/package-frame.html b/docs/javadoc/ca/uqac/lif/textidote/render/package-frame.html index 17024f64..2f130e67 100644 --- a/docs/javadoc/ca/uqac/lif/textidote/render/package-frame.html +++ b/docs/javadoc/ca/uqac/lif/textidote/render/package-frame.html @@ -2,10 +2,10 @@ - + ca.uqac.lif.textidote.render (TeXtidote Documentation) - + diff --git a/docs/javadoc/ca/uqac/lif/textidote/render/package-summary.html b/docs/javadoc/ca/uqac/lif/textidote/render/package-summary.html index eec317cc..83a21e75 100644 --- a/docs/javadoc/ca/uqac/lif/textidote/render/package-summary.html +++ b/docs/javadoc/ca/uqac/lif/textidote/render/package-summary.html @@ -2,10 +2,10 @@ - + ca.uqac.lif.textidote.render (TeXtidote Documentation) - + @@ -86,7 +86,7 @@

    Package ca.uqac.lif.textidote.render

    AnsiAdviceRenderer -
    Renders a list of advice to a terminal (such as stdin), using colored output.
    +
    Renders a list of advice to a terminal (such as stdin), using colored output.
    diff --git a/docs/javadoc/ca/uqac/lif/textidote/render/package-tree.html b/docs/javadoc/ca/uqac/lif/textidote/render/package-tree.html index 424c37f9..351c144b 100644 --- a/docs/javadoc/ca/uqac/lif/textidote/render/package-tree.html +++ b/docs/javadoc/ca/uqac/lif/textidote/render/package-tree.html @@ -2,10 +2,10 @@ - + ca.uqac.lif.textidote.render Class Hierarchy (TeXtidote Documentation) - + diff --git a/docs/javadoc/ca/uqac/lif/textidote/render/package-use.html b/docs/javadoc/ca/uqac/lif/textidote/render/package-use.html index f170017a..081e10a1 100644 --- a/docs/javadoc/ca/uqac/lif/textidote/render/package-use.html +++ b/docs/javadoc/ca/uqac/lif/textidote/render/package-use.html @@ -2,10 +2,10 @@ - + Uses of Package ca.uqac.lif.textidote.render (TeXtidote Documentation) - + diff --git a/docs/javadoc/ca/uqac/lif/textidote/rules/CheckCaptions.html b/docs/javadoc/ca/uqac/lif/textidote/rules/CheckCaptions.html index 0047e29b..61469b55 100644 --- a/docs/javadoc/ca/uqac/lif/textidote/rules/CheckCaptions.html +++ b/docs/javadoc/ca/uqac/lif/textidote/rules/CheckCaptions.html @@ -2,10 +2,10 @@ - + CheckCaptions (TeXtidote Documentation) - + diff --git a/docs/javadoc/ca/uqac/lif/textidote/rules/CheckFigurePaths.html b/docs/javadoc/ca/uqac/lif/textidote/rules/CheckFigurePaths.html index 0f5ca4bb..00f19e29 100644 --- a/docs/javadoc/ca/uqac/lif/textidote/rules/CheckFigurePaths.html +++ b/docs/javadoc/ca/uqac/lif/textidote/rules/CheckFigurePaths.html @@ -2,10 +2,10 @@ - + CheckFigurePaths (TeXtidote Documentation) - + diff --git a/docs/javadoc/ca/uqac/lif/textidote/rules/CheckFigureReferences.html b/docs/javadoc/ca/uqac/lif/textidote/rules/CheckFigureReferences.html index 729c0a7b..5d1e5c6f 100644 --- a/docs/javadoc/ca/uqac/lif/textidote/rules/CheckFigureReferences.html +++ b/docs/javadoc/ca/uqac/lif/textidote/rules/CheckFigureReferences.html @@ -2,10 +2,10 @@ - + CheckFigureReferences (TeXtidote Documentation) - + diff --git a/docs/javadoc/ca/uqac/lif/textidote/rules/CheckLanguage.CheckLanguageSpecific.html b/docs/javadoc/ca/uqac/lif/textidote/rules/CheckLanguage.CheckLanguageSpecific.html index e2a70a83..efdc0e52 100644 --- a/docs/javadoc/ca/uqac/lif/textidote/rules/CheckLanguage.CheckLanguageSpecific.html +++ b/docs/javadoc/ca/uqac/lif/textidote/rules/CheckLanguage.CheckLanguageSpecific.html @@ -2,10 +2,10 @@ - + CheckLanguage.CheckLanguageSpecific (TeXtidote Documentation) - + diff --git a/docs/javadoc/ca/uqac/lif/textidote/rules/CheckLanguage.UnsupportedLanguageException.html b/docs/javadoc/ca/uqac/lif/textidote/rules/CheckLanguage.UnsupportedLanguageException.html index 9fc46e17..efee8455 100644 --- a/docs/javadoc/ca/uqac/lif/textidote/rules/CheckLanguage.UnsupportedLanguageException.html +++ b/docs/javadoc/ca/uqac/lif/textidote/rules/CheckLanguage.UnsupportedLanguageException.html @@ -2,10 +2,10 @@ - + CheckLanguage.UnsupportedLanguageException (TeXtidote Documentation) - + diff --git a/docs/javadoc/ca/uqac/lif/textidote/rules/CheckLanguage.html b/docs/javadoc/ca/uqac/lif/textidote/rules/CheckLanguage.html index d6b47114..578a5a9e 100644 --- a/docs/javadoc/ca/uqac/lif/textidote/rules/CheckLanguage.html +++ b/docs/javadoc/ca/uqac/lif/textidote/rules/CheckLanguage.html @@ -2,10 +2,10 @@ - + CheckLanguage (TeXtidote Documentation) - + diff --git a/docs/javadoc/ca/uqac/lif/textidote/rules/CheckNoBreak.html b/docs/javadoc/ca/uqac/lif/textidote/rules/CheckNoBreak.html index ba817d7b..77926272 100644 --- a/docs/javadoc/ca/uqac/lif/textidote/rules/CheckNoBreak.html +++ b/docs/javadoc/ca/uqac/lif/textidote/rules/CheckNoBreak.html @@ -2,10 +2,10 @@ - + CheckNoBreak (TeXtidote Documentation) - + diff --git a/docs/javadoc/ca/uqac/lif/textidote/rules/CheckSubsectionSize.html b/docs/javadoc/ca/uqac/lif/textidote/rules/CheckSubsectionSize.html index 90de4b38..4d962f24 100644 --- a/docs/javadoc/ca/uqac/lif/textidote/rules/CheckSubsectionSize.html +++ b/docs/javadoc/ca/uqac/lif/textidote/rules/CheckSubsectionSize.html @@ -2,10 +2,10 @@ - + CheckSubsectionSize (TeXtidote Documentation) - + diff --git a/docs/javadoc/ca/uqac/lif/textidote/rules/CheckSubsections.html b/docs/javadoc/ca/uqac/lif/textidote/rules/CheckSubsections.html index 916c2fc2..fd85d547 100644 --- a/docs/javadoc/ca/uqac/lif/textidote/rules/CheckSubsections.html +++ b/docs/javadoc/ca/uqac/lif/textidote/rules/CheckSubsections.html @@ -2,10 +2,10 @@ - + CheckSubsections (TeXtidote Documentation) - + diff --git a/docs/javadoc/ca/uqac/lif/textidote/rules/LanguageFactory.html b/docs/javadoc/ca/uqac/lif/textidote/rules/LanguageFactory.html index be22fa7e..cf5634af 100644 --- a/docs/javadoc/ca/uqac/lif/textidote/rules/LanguageFactory.html +++ b/docs/javadoc/ca/uqac/lif/textidote/rules/LanguageFactory.html @@ -2,10 +2,10 @@ - + LanguageFactory (TeXtidote Documentation) - + diff --git a/docs/javadoc/ca/uqac/lif/textidote/rules/RegexRule.html b/docs/javadoc/ca/uqac/lif/textidote/rules/RegexRule.html index fc79b445..3c258f67 100644 --- a/docs/javadoc/ca/uqac/lif/textidote/rules/RegexRule.html +++ b/docs/javadoc/ca/uqac/lif/textidote/rules/RegexRule.html @@ -2,10 +2,10 @@ - + RegexRule (TeXtidote Documentation) - + diff --git a/docs/javadoc/ca/uqac/lif/textidote/rules/class-use/CheckCaptions.html b/docs/javadoc/ca/uqac/lif/textidote/rules/class-use/CheckCaptions.html index 3f374cb2..20166b4f 100644 --- a/docs/javadoc/ca/uqac/lif/textidote/rules/class-use/CheckCaptions.html +++ b/docs/javadoc/ca/uqac/lif/textidote/rules/class-use/CheckCaptions.html @@ -2,10 +2,10 @@ - + Uses of Class ca.uqac.lif.textidote.rules.CheckCaptions (TeXtidote Documentation) - + diff --git a/docs/javadoc/ca/uqac/lif/textidote/rules/class-use/CheckFigurePaths.html b/docs/javadoc/ca/uqac/lif/textidote/rules/class-use/CheckFigurePaths.html index cba3f4e2..bb9572f6 100644 --- a/docs/javadoc/ca/uqac/lif/textidote/rules/class-use/CheckFigurePaths.html +++ b/docs/javadoc/ca/uqac/lif/textidote/rules/class-use/CheckFigurePaths.html @@ -2,10 +2,10 @@ - + Uses of Class ca.uqac.lif.textidote.rules.CheckFigurePaths (TeXtidote Documentation) - + diff --git a/docs/javadoc/ca/uqac/lif/textidote/rules/class-use/CheckFigureReferences.html b/docs/javadoc/ca/uqac/lif/textidote/rules/class-use/CheckFigureReferences.html index f6a4b726..3f7f5b2d 100644 --- a/docs/javadoc/ca/uqac/lif/textidote/rules/class-use/CheckFigureReferences.html +++ b/docs/javadoc/ca/uqac/lif/textidote/rules/class-use/CheckFigureReferences.html @@ -2,10 +2,10 @@ - + Uses of Class ca.uqac.lif.textidote.rules.CheckFigureReferences (TeXtidote Documentation) - + diff --git a/docs/javadoc/ca/uqac/lif/textidote/rules/class-use/CheckLanguage.CheckLanguageSpecific.html b/docs/javadoc/ca/uqac/lif/textidote/rules/class-use/CheckLanguage.CheckLanguageSpecific.html index 26e35643..086cd51a 100644 --- a/docs/javadoc/ca/uqac/lif/textidote/rules/class-use/CheckLanguage.CheckLanguageSpecific.html +++ b/docs/javadoc/ca/uqac/lif/textidote/rules/class-use/CheckLanguage.CheckLanguageSpecific.html @@ -2,10 +2,10 @@ - + Uses of Class ca.uqac.lif.textidote.rules.CheckLanguage.CheckLanguageSpecific (TeXtidote Documentation) - + diff --git a/docs/javadoc/ca/uqac/lif/textidote/rules/class-use/CheckLanguage.UnsupportedLanguageException.html b/docs/javadoc/ca/uqac/lif/textidote/rules/class-use/CheckLanguage.UnsupportedLanguageException.html index a20bf966..5cb27417 100644 --- a/docs/javadoc/ca/uqac/lif/textidote/rules/class-use/CheckLanguage.UnsupportedLanguageException.html +++ b/docs/javadoc/ca/uqac/lif/textidote/rules/class-use/CheckLanguage.UnsupportedLanguageException.html @@ -2,10 +2,10 @@ - + Uses of Class ca.uqac.lif.textidote.rules.CheckLanguage.UnsupportedLanguageException (TeXtidote Documentation) - + diff --git a/docs/javadoc/ca/uqac/lif/textidote/rules/class-use/CheckLanguage.html b/docs/javadoc/ca/uqac/lif/textidote/rules/class-use/CheckLanguage.html index 55c2a40a..2e908fa3 100644 --- a/docs/javadoc/ca/uqac/lif/textidote/rules/class-use/CheckLanguage.html +++ b/docs/javadoc/ca/uqac/lif/textidote/rules/class-use/CheckLanguage.html @@ -2,10 +2,10 @@ - + Uses of Class ca.uqac.lif.textidote.rules.CheckLanguage (TeXtidote Documentation) - + diff --git a/docs/javadoc/ca/uqac/lif/textidote/rules/class-use/CheckNoBreak.html b/docs/javadoc/ca/uqac/lif/textidote/rules/class-use/CheckNoBreak.html index 74b8f0e8..6a3a4a20 100644 --- a/docs/javadoc/ca/uqac/lif/textidote/rules/class-use/CheckNoBreak.html +++ b/docs/javadoc/ca/uqac/lif/textidote/rules/class-use/CheckNoBreak.html @@ -2,10 +2,10 @@ - + Uses of Class ca.uqac.lif.textidote.rules.CheckNoBreak (TeXtidote Documentation) - + diff --git a/docs/javadoc/ca/uqac/lif/textidote/rules/class-use/CheckSubsectionSize.html b/docs/javadoc/ca/uqac/lif/textidote/rules/class-use/CheckSubsectionSize.html index 0b40f78f..8f5a8746 100644 --- a/docs/javadoc/ca/uqac/lif/textidote/rules/class-use/CheckSubsectionSize.html +++ b/docs/javadoc/ca/uqac/lif/textidote/rules/class-use/CheckSubsectionSize.html @@ -2,10 +2,10 @@ - + Uses of Class ca.uqac.lif.textidote.rules.CheckSubsectionSize (TeXtidote Documentation) - + diff --git a/docs/javadoc/ca/uqac/lif/textidote/rules/class-use/CheckSubsections.html b/docs/javadoc/ca/uqac/lif/textidote/rules/class-use/CheckSubsections.html index 1aa8a881..2091a57e 100644 --- a/docs/javadoc/ca/uqac/lif/textidote/rules/class-use/CheckSubsections.html +++ b/docs/javadoc/ca/uqac/lif/textidote/rules/class-use/CheckSubsections.html @@ -2,10 +2,10 @@ - + Uses of Class ca.uqac.lif.textidote.rules.CheckSubsections (TeXtidote Documentation) - + diff --git a/docs/javadoc/ca/uqac/lif/textidote/rules/class-use/LanguageFactory.html b/docs/javadoc/ca/uqac/lif/textidote/rules/class-use/LanguageFactory.html index 2c70a1f3..38e1225c 100644 --- a/docs/javadoc/ca/uqac/lif/textidote/rules/class-use/LanguageFactory.html +++ b/docs/javadoc/ca/uqac/lif/textidote/rules/class-use/LanguageFactory.html @@ -2,10 +2,10 @@ - + Uses of Class ca.uqac.lif.textidote.rules.LanguageFactory (TeXtidote Documentation) - + diff --git a/docs/javadoc/ca/uqac/lif/textidote/rules/class-use/RegexRule.html b/docs/javadoc/ca/uqac/lif/textidote/rules/class-use/RegexRule.html index 03ddcf9e..ba93210f 100644 --- a/docs/javadoc/ca/uqac/lif/textidote/rules/class-use/RegexRule.html +++ b/docs/javadoc/ca/uqac/lif/textidote/rules/class-use/RegexRule.html @@ -2,10 +2,10 @@ - + Uses of Class ca.uqac.lif.textidote.rules.RegexRule (TeXtidote Documentation) - + diff --git a/docs/javadoc/ca/uqac/lif/textidote/rules/package-frame.html b/docs/javadoc/ca/uqac/lif/textidote/rules/package-frame.html index 1ebf266d..292feec8 100644 --- a/docs/javadoc/ca/uqac/lif/textidote/rules/package-frame.html +++ b/docs/javadoc/ca/uqac/lif/textidote/rules/package-frame.html @@ -2,10 +2,10 @@ - + ca.uqac.lif.textidote.rules (TeXtidote Documentation) - + diff --git a/docs/javadoc/ca/uqac/lif/textidote/rules/package-summary.html b/docs/javadoc/ca/uqac/lif/textidote/rules/package-summary.html index 01cde20a..fd4577d9 100644 --- a/docs/javadoc/ca/uqac/lif/textidote/rules/package-summary.html +++ b/docs/javadoc/ca/uqac/lif/textidote/rules/package-summary.html @@ -2,10 +2,10 @@ - + ca.uqac.lif.textidote.rules (TeXtidote Documentation) - + diff --git a/docs/javadoc/ca/uqac/lif/textidote/rules/package-tree.html b/docs/javadoc/ca/uqac/lif/textidote/rules/package-tree.html index b90d7a0a..f4d0d9c5 100644 --- a/docs/javadoc/ca/uqac/lif/textidote/rules/package-tree.html +++ b/docs/javadoc/ca/uqac/lif/textidote/rules/package-tree.html @@ -2,10 +2,10 @@ - + ca.uqac.lif.textidote.rules Class Hierarchy (TeXtidote Documentation) - + diff --git a/docs/javadoc/ca/uqac/lif/textidote/rules/package-use.html b/docs/javadoc/ca/uqac/lif/textidote/rules/package-use.html index 2b3c05bf..fd5e6478 100644 --- a/docs/javadoc/ca/uqac/lif/textidote/rules/package-use.html +++ b/docs/javadoc/ca/uqac/lif/textidote/rules/package-use.html @@ -2,10 +2,10 @@ - + Uses of Package ca.uqac.lif.textidote.rules (TeXtidote Documentation) - + diff --git a/docs/javadoc/ca/uqac/lif/util/AnsiPrinter.Color.html b/docs/javadoc/ca/uqac/lif/util/AnsiPrinter.Color.html index ef716e4f..46347339 100644 --- a/docs/javadoc/ca/uqac/lif/util/AnsiPrinter.Color.html +++ b/docs/javadoc/ca/uqac/lif/util/AnsiPrinter.Color.html @@ -2,10 +2,10 @@ - + AnsiPrinter.Color (TeXtidote Documentation) - + diff --git a/docs/javadoc/ca/uqac/lif/util/AnsiPrinter.html b/docs/javadoc/ca/uqac/lif/util/AnsiPrinter.html index ad7aaf74..dda95de2 100644 --- a/docs/javadoc/ca/uqac/lif/util/AnsiPrinter.html +++ b/docs/javadoc/ca/uqac/lif/util/AnsiPrinter.html @@ -2,10 +2,10 @@ - + AnsiPrinter (TeXtidote Documentation) - + diff --git a/docs/javadoc/ca/uqac/lif/util/NullPrintStream.html b/docs/javadoc/ca/uqac/lif/util/NullPrintStream.html index 72acbdd9..d08ac76c 100644 --- a/docs/javadoc/ca/uqac/lif/util/NullPrintStream.html +++ b/docs/javadoc/ca/uqac/lif/util/NullPrintStream.html @@ -2,10 +2,10 @@ - + NullPrintStream (TeXtidote Documentation) - + diff --git a/docs/javadoc/ca/uqac/lif/util/class-use/AnsiPrinter.Color.html b/docs/javadoc/ca/uqac/lif/util/class-use/AnsiPrinter.Color.html index 0924e7c1..4d81f874 100644 --- a/docs/javadoc/ca/uqac/lif/util/class-use/AnsiPrinter.Color.html +++ b/docs/javadoc/ca/uqac/lif/util/class-use/AnsiPrinter.Color.html @@ -2,10 +2,10 @@ - + Uses of Class ca.uqac.lif.util.AnsiPrinter.Color (TeXtidote Documentation) - + diff --git a/docs/javadoc/ca/uqac/lif/util/class-use/AnsiPrinter.html b/docs/javadoc/ca/uqac/lif/util/class-use/AnsiPrinter.html index c536aa12..f44e079d 100644 --- a/docs/javadoc/ca/uqac/lif/util/class-use/AnsiPrinter.html +++ b/docs/javadoc/ca/uqac/lif/util/class-use/AnsiPrinter.html @@ -2,10 +2,10 @@ - + Uses of Class ca.uqac.lif.util.AnsiPrinter (TeXtidote Documentation) - + @@ -158,7 +158,9 @@

    Uses of -AnsiAdviceRenderer(AnsiPrinter printer)  +AnsiAdviceRenderer(AnsiPrinter printer) +
    Creates a new advice renderer
    + HtmlAdviceRenderer(AnsiPrinter printer, diff --git a/docs/javadoc/ca/uqac/lif/util/class-use/NullPrintStream.html b/docs/javadoc/ca/uqac/lif/util/class-use/NullPrintStream.html index cab0ee86..2de472fd 100644 --- a/docs/javadoc/ca/uqac/lif/util/class-use/NullPrintStream.html +++ b/docs/javadoc/ca/uqac/lif/util/class-use/NullPrintStream.html @@ -2,10 +2,10 @@ - + Uses of Class ca.uqac.lif.util.NullPrintStream (TeXtidote Documentation) - + diff --git a/docs/javadoc/ca/uqac/lif/util/package-frame.html b/docs/javadoc/ca/uqac/lif/util/package-frame.html index c4326517..ea48847c 100644 --- a/docs/javadoc/ca/uqac/lif/util/package-frame.html +++ b/docs/javadoc/ca/uqac/lif/util/package-frame.html @@ -2,10 +2,10 @@ - + ca.uqac.lif.util (TeXtidote Documentation) - + diff --git a/docs/javadoc/ca/uqac/lif/util/package-summary.html b/docs/javadoc/ca/uqac/lif/util/package-summary.html index 37bac334..04ad657e 100644 --- a/docs/javadoc/ca/uqac/lif/util/package-summary.html +++ b/docs/javadoc/ca/uqac/lif/util/package-summary.html @@ -2,10 +2,10 @@ - + ca.uqac.lif.util (TeXtidote Documentation) - + diff --git a/docs/javadoc/ca/uqac/lif/util/package-tree.html b/docs/javadoc/ca/uqac/lif/util/package-tree.html index b6b7a322..a7f6d674 100644 --- a/docs/javadoc/ca/uqac/lif/util/package-tree.html +++ b/docs/javadoc/ca/uqac/lif/util/package-tree.html @@ -2,10 +2,10 @@ - + ca.uqac.lif.util Class Hierarchy (TeXtidote Documentation) - + diff --git a/docs/javadoc/ca/uqac/lif/util/package-use.html b/docs/javadoc/ca/uqac/lif/util/package-use.html index f00720af..fd932eae 100644 --- a/docs/javadoc/ca/uqac/lif/util/package-use.html +++ b/docs/javadoc/ca/uqac/lif/util/package-use.html @@ -2,10 +2,10 @@ - + Uses of Package ca.uqac.lif.util (TeXtidote Documentation) - + diff --git a/docs/javadoc/constant-values.html b/docs/javadoc/constant-values.html index 7915e218..3fd5c2cf 100644 --- a/docs/javadoc/constant-values.html +++ b/docs/javadoc/constant-values.html @@ -2,10 +2,10 @@ - + Constant Field Values (TeXtidote Documentation) - + diff --git a/docs/javadoc/deprecated-list.html b/docs/javadoc/deprecated-list.html index 80ae9c60..1757c2ae 100644 --- a/docs/javadoc/deprecated-list.html +++ b/docs/javadoc/deprecated-list.html @@ -2,10 +2,10 @@ - + Deprecated List (TeXtidote Documentation) - + diff --git a/docs/javadoc/help-doc.html b/docs/javadoc/help-doc.html index 43b92a17..8b97ee34 100644 --- a/docs/javadoc/help-doc.html +++ b/docs/javadoc/help-doc.html @@ -2,10 +2,10 @@ - + API Help (TeXtidote Documentation) - + diff --git a/docs/javadoc/index-all.html b/docs/javadoc/index-all.html index e18e7e9a..137e9f92 100644 --- a/docs/javadoc/index-all.html +++ b/docs/javadoc/index-all.html @@ -2,10 +2,10 @@ - + Index (TeXtidote Documentation) - + @@ -129,10 +129,12 @@

    A

    AnsiAdviceRenderer - Class in ca.uqac.lif.textidote.render
    -
    Renders a list of advice to a terminal (such as stdin), using colored output.
    +
    Renders a list of advice to a terminal (such as stdin), using colored output.
    AnsiAdviceRenderer(AnsiPrinter) - Constructor for class ca.uqac.lif.textidote.render.AnsiAdviceRenderer
    -
     
    +
    +
    Creates a new advice renderer
    +
    AnsiPrinter - Class in ca.uqac.lif.util
    Print stream with facilities for producing colored text using ANSI escape codes.
    @@ -756,7 +758,9 @@

    M

    The start position of the range
    m_terminalLineWidth - Variable in class ca.uqac.lif.textidote.render.AnsiAdviceRenderer
    -
     
    +
    +
    The width of the line in the terminal (in number of characters)
    +
    Main - Class in ca.uqac.lif.textidote
    Command-line interface for TeXtidote.
    @@ -765,7 +769,7 @@

    M

     
    main(String[]) - Static method in class ca.uqac.lif.textidote.Main
    -
    Main method
    +
    Main method.
    mainLoop(String[]) - Static method in class ca.uqac.lif.textidote.Main
    @@ -848,7 +852,9 @@

    P

    Prints the contents of an associative map
    printSpaces(int) - Method in class ca.uqac.lif.textidote.render.AnsiAdviceRenderer
    -
     
    +
    +
    Prints some spaces
    +
    @@ -924,7 +930,9 @@

    R

    render(List<Advice>) - Method in class ca.uqac.lif.textidote.render.HtmlAdviceRenderer
     
    renderExcerpt(String, Range) - Method in class ca.uqac.lif.textidote.render.AnsiAdviceRenderer
    -
     
    +
    +
    Renders a line of text and “highlights” a portion of it.
    +
    replace(String, String, Position) - Method in class ca.uqac.lif.textidote.as.AnnotatedString
    Replaces a pattern by another in the string.
    @@ -1089,7 +1097,9 @@

    V

    W

    wrap(String, String, int) - Method in class ca.uqac.lif.textidote.render.AnsiAdviceRenderer
    -
     
    +
    +
    Prints a sequence of words, using word wrapping and indenting each new line
    +
    diff --git a/docs/javadoc/index.html b/docs/javadoc/index.html index 824dcdb0..ed4317cf 100644 --- a/docs/javadoc/index.html +++ b/docs/javadoc/index.html @@ -2,7 +2,7 @@ - + TeXtidote Documentation diff --git a/docs/javadoc/overview-summary.html b/docs/javadoc/overview-summary.html index ebb05acd..49965613 100644 --- a/docs/javadoc/overview-summary.html +++ b/docs/javadoc/overview-summary.html @@ -2,10 +2,10 @@ - + Overview (TeXtidote Documentation) - + diff --git a/docs/javadoc/overview-tree.html b/docs/javadoc/overview-tree.html index ceb7369c..fbb12308 100644 --- a/docs/javadoc/overview-tree.html +++ b/docs/javadoc/overview-tree.html @@ -2,10 +2,10 @@ - + Class Hierarchy (TeXtidote Documentation) - + diff --git a/docs/javadoc/serialized-form.html b/docs/javadoc/serialized-form.html index c611843e..32f66a11 100644 --- a/docs/javadoc/serialized-form.html +++ b/docs/javadoc/serialized-form.html @@ -2,10 +2,10 @@ - + Serialized Form (TeXtidote Documentation) - +