diff --git a/examples/example1_complete_report/createDocs.sh b/examples/example1_complete_report/createDocs.sh index 7e88173..44cd0f8 100755 --- a/examples/example1_complete_report/createDocs.sh +++ b/examples/example1_complete_report/createDocs.sh @@ -12,7 +12,7 @@ javadoc -docletpath ../../target/TeXDoclet.jar \ -title "TeXDoclet Java Documentation" \ -subtitle "Created with Javadoc TeXDoclet Doclet" \ -author "Greg Wonderly \and S{\"o}ren Caspersen \and Stefan Marx" \ - -sourcepath ../../src/main/java \ + -sourcepath ../../src/main/java:../../src/test/java \ -subpackages org \ -shortinherited diff --git a/src/test/java/org/stfm/texdoclet/MarkdownTest.java b/src/test/java/org/stfm/texdoclet/MarkdownTest.java new file mode 100644 index 0000000..f1c999a --- /dev/null +++ b/src/test/java/org/stfm/texdoclet/MarkdownTest.java @@ -0,0 +1,285 @@ +package org.stfm.texdoclet; + +/** + * This class is just for testing the Mardown processing output. + * + *
+ * ### a) Some text
+ * 
+ * + * Markdown code : + * + *
+ * 
+ * some text some text some text some text some text some text some 
+ * text some text some text some text some text some text some text 
+ * some text some text some text with 2 ending spaces  
+ * 
+ * text some text some text some text some text some text some text 
+ * some text some text some text some text some text some text some text
+ * 
+ * text some text some text some text some text some text some text 
+ * some text some text
+ * 
+ * 
+ * + * results in : + * + *
+ * 
+ * some text some text some text some text some text some text some 
+ * text some text some text some text some text some text some text 
+ * some text some text some text with 2 ending spaces  
+ * 
+ * text some text some text some text some text some text some text 
+ * some text some text some text some text some text some text some text
+ * 
+ * text some text some text some text some text some text some text 
+ * some text some text
+ * 
+ * 
+ * + *
+ * ### b) Lists
+ * 
+ * + * Markdown code : + * + *
+ * unsorted :
+ * 
+ * - item1 
+ *     - item11 
+ *     - item12 
+ * - item2
+ * 
+ * or :
+ * 
+ * + item1 
+ *     + item12
+ *         + item13
+ *    
+ * sorted :
+ * 
+ * 1. item1 
+ *     1. item11 
+ *     2. item12 
+ * 2. item2
+ *     - item21
+ *     - item22
+ * 3. item3
+ *   
+ * lists with paragraphs :
+ * 
+ * 1. some text some text some text some text some text some text some text some
+ * text some text some text
+ * 
+ *     some text some text some text some text some text some text
+ * 
+ * 2. some text some text some text some text some text some text
+ * 
+ * 
+ * + * results in : + * + *
+ * unsorted :
+ * 
+ * - item1 
+ *     - item11 
+ *     - item12 
+ * - item2
+ * 
+ * or :
+ * 
+ * + item1 
+ *     + item12
+ *         + item13
+ * 
+ * sorted :
+ * 
+ * 1. item1 
+ *     1. item11 
+ *     2. item12 
+ * 2. item2
+ *     - item21
+ *     - item22
+ * 3. item3
+ *   
+ * lists with paragraphs :
+ * 
+ * 1. some text some text some text some text some text some text some text some
+ * text some text some text
+ * 
+ *     some text some text some text some text some text some text
+ * 
+ * 2. some text some text some text some text some text some text
+ * 
+ * 
+ * + *
+ * ### c) Blockquotes
+ * 
+ * + * Markdown code : + * + *
+ * 
+ * some text some text some text some text some text some text
+ * 
+ * > some quoting text
+ * > 
+ * > > some nested quoting text 
+ * >
+ * > some quoting text 
+ * > 
+ * > ###### header in blockquote
+ * >
+ * > a list in blockquote : 
+ * > 
+ * > 1. item1
+ * > 2. item2
+ * >     1. item21
+ * >     2. item22
+ * > 3. item3
+ * >
+ * > some quoting text
+ * >
+ * >    code in blockquote
+ * 
+ * 
+ * + * results in : + * + *
+ * 
+ * some text some text some text some text some text some text
+ * 
+ * > some quoting text
+ * > 
+ * > > some nested quoting text 
+ * >
+ * > some quoting text 
+ * > 
+ * > ###### header in blockquote
+ * >
+ * > a list in blockquote : 
+ * > 
+ * > 1. item1
+ * > 2. item2
+ * >     1. item21
+ * >     2. item22
+ * > 3. item3
+ * >
+ * > some quoting text
+ * >
+ * >    code in blockquote
+ * 
+ * 
+ * + *
+ * ### d) Preformatted text
+ * 
+ * + * Markdown code : + * + *
+ * 
+ * some preformatted :
+ * 
+ *     code line 1 
+ *     code line 2
+ * 
+ * 
+ * + * results in : + * + *
+ * 
+ * some preformatted :
+ * 
+ *     code line 1 
+ *     code line 2
+ * 
+ * 
+ * + *
+ * ### e) Horizontal rules
+ * 
+ * + * Markdown code : + * + *
+ * 
+ * ***
+ * 
+ * 
+ * + * results in : + * + *
+ * 
+ * ***
+ * 
+ * 
+ * + *
+ * ### f) Emphasis
+ * 
+ * + * Markdown code : + * + *
+ * 
+ * *single asterisks* (em)
+ * 
+ * _single underscores_ (em)
+ * 
+ * **double asterisks** (strong)
+ * 
+ * __double underscores__ (strong)
+ * 
+ * 
+ * + * results in : + * + *
+ * 
+ * *single asterisks* (em)
+ * 
+ * _single underscores_ (em)
+ * 
+ * **double asterisks** (strong)
+ * 
+ * __double underscores__ (strong)
+ * 
+ * 
+ * + *
+ * ### h) Code
+ * 
+ * + * Markdown code : + * + *
+ * 
+ * some code : `TeXDoclet extends Doclet` and ``There is a literal backtick (`)
+ * here.``
+ * 
+ * 
+ * + * results in : + * + *
+ * 
+ * some code : `TeXDoclet extends Doclet` and ``There is a literal backtick (`)
+ * here.``
+ * 
+ * 
+ * + * @author Stefan Marx + * + */ +public class MarkdownTest { + +}