Merge pull request #2 from weedySeaDragon/190311-plantuml-18-10-17-BETA

190311 plantuml 18 10 17 beta
weedySeaDragon · Mar 11, 2019 · 645c582 · 645c582
2 parents 64d0c42 + 3088162
commit 645c582
Show file tree

Hide file tree

Showing 453 changed files with 824 additions and 2,326 deletions.
diff --git a/build.gradle b/build.gradle
@@ -1,37 +1,28 @@
 plugins {
-    id 'groovy'
-    id 'java'
+    id "java"
+    id "groovy"
 
+    // gradle plugin for running sphinx
     id "kr.motd.sphinx" version "2.3.1"
 }
 
-group 'com.ashleycaroline.plantuml'
-version '1.0-SNAPSHOT'
 
-sourceCompatibility = 1.9
 
-repositories {
-    mavenCentral()
-}
+description 'Sphinx site source files for my ReadTheDocs documentation site about PlantUML'
 
-dependencies {
-    compile 'org.codehaus.groovy:groovy-all:2.3.11'
-
-}
+allprojects {
 
+    group 'com.ashleycaroline.plantuml'
+    version '1.0.1'
 
-ext.vendor = "Ashley Engelund"
-ext.vendorId = "com.ashleycaroline"
-ext.specificationVendor = vendor
-ext.specificationVendorId = vendorId
-ext.implementationVendor = vendor
-ext.implementationVendorId = vendorId
-ext.specificationTitleStart = "Ashley's PlantUML Documentation"
-ext.implementationTitleStart = "AEPlantUMLDoc"
+    repositories {
+        mavenCentral()
+    }
 
-ext.rootPackage = 'com.ashleycaroline.plantuml-documentation'
+    apply plugin: 'groovy'
+    apply plugin: 'kr.motd.sphinx'
 
-ext.moduleName = rootPackage + '.' + project.getName();
+}
 
 
 sphinx {

diff --git a/generateDocInfo/build.gradle b/generateDocInfo/build.gradle
@@ -1,18 +1,15 @@
 import org.gradle.internal.jvm.Jvm
 import static org.gradle.internal.os.OperatingSystem.current
 
-plugins {
-    id 'java'
-}
+apply plugin: 'java'
 
-group 'com.ashleycaroline.plantuml'
-version '1.0.1'
 
-sourceCompatibility = 1.9
+project.description = 'Takes input .txt files generated by PlantUML (e.g. language, color, keywords, etc.) and produces ColorSamples and Keyword .rst files that can be used in documentation.'
 
-repositories {
-    mavenCentral()
+// java source
+sourceCompatibility = 1.10
 
+repositories {
     flatDir {
         dirs 'libs'
     }
@@ -32,19 +29,32 @@ dependencies {
 
     // https://mvnrepository.com/artifact/org.junit.jupiter/junit-jupiter-api
     testCompile group: 'org.junit.jupiter', name: 'junit-jupiter-api', version: '5.3.1'
-
     testCompile name: 'plantuml'
-
 }
 
 
+ext.vendor = "Ashley Engelund"
+ext.vendorId = "com.ashleycaroline"
+ext.specificationVendor = vendor
+ext.specificationVendorId = vendorId
+ext.implementationVendor = vendor
+ext.implementationVendorId = vendorId
+ext.specificationTitleStart = "Ashley's PlantUML Documentation"
+ext.implementationTitleStart = "AEPlantUMLDoc"
+
+ext.rootPackage = 'com.ashleycaroline.plantuml-documentation'
+
+ext.moduleName = rootPackage + '.' + project.getName();
+
+
 jar {
     manifest {
         attributes(
                 'Automatic-Module-Name': "${project.getName()}",
                 "Specification-Title": "$project.name",
                 "Specification-Vendor": specificationVendor,
                 "Specification-Version": version,
+                "Specification-Description": "$project.description",
                 "Implementation-Title": "${implementationTitleStart} - $project.name",
                 "Implementation-Version": version,
                 "Implementation-Vendor": implementationVendor,
@@ -59,7 +69,29 @@ jar {
 
     test {
         // uncomment the following to print out the class path when test task is run:
-        //println(classpath.asPath)
+        // println(classpath.asPath)
     }    
 
-}
+}
+
+
+javadoc {
+    options.addBooleanOption('html5', true)
+}
+
+
+sphinx {
+
+    // Change the source directory.
+    sourceDirectory = "${projectDir}/docs"
+
+    // Change the output directory.
+    // outputDirectory = "${project.buildDir}/alternative-site"
+
+    // Add environment variables.
+    // environments = ['ENV_FOO': 'value1', 'ENV_BAR': 'value2']
+    // env 'ENV_BAZ', 'value3'
+
+    // Add tags.
+    // tags 'tagA', 'tagB'
+}
diff --git a/...cInfo/src/main/java/com/ashleycaroline/plantuml/generateDocInfo/ColorSampleRSTWriter.java b/...cInfo/src/main/java/com/ashleycaroline/plantuml/generateDocInfo/ColorSampleRSTWriter.java
@@ -29,16 +29,16 @@
  * +------------------------------------------------+------------------------------------------------+------------------------------------------------+------------------------------------------------+------------------------------------------------+
  *
  *
- *  @file ColorSampleRSTWriter
- *  @project documentation  (local project name)
+ *  file: ColorSampleRSTWriter
+ *  project: plantuml-documentation  (local project name)
  *
  *  @author Ashley Engelund   [email protected] | weedySeaDragon@github
  *  @since 11 Oct 2018
  *
  ********************************************************************************/
 
 
-public class ColorSampleRSTWriter {
+class ColorSampleRSTWriter {
 
 
     private static final Integer TABLE_COLUMN_LENGTH = 48;
@@ -51,13 +51,13 @@ public class ColorSampleRSTWriter {
     // ================================================
 
 
-    public void add_color( String colorName ) {
+     void add_color( String colorName ) {
 
         _colors.add( colorName );
     }
 
 
-    public ArrayList< String > get_colors() {
+    ArrayList< String > get_colors() {
 
         return _colors;
     }
@@ -66,7 +66,7 @@ public ArrayList< String > get_colors() {
     /**
      * @return [String] the ReStructuredText table filled with the colors we have
      */
-    public String generate_rst_table() {
+    String generate_rst_table() {
 
         StringBuilder rstSB = new StringBuilder();
 
@@ -117,9 +117,9 @@ public String generate_rst_table() {
      * - blank_line
      * - color_name_line
      *
-     * @param colors [List<String>]  the list of colors
+     * @param colors List of String -  the list of colors
      *
-     * @return [String]
+     * @return String
      */
     protected String table_row_for( ArrayList< String > colors ) {
 
@@ -144,7 +144,7 @@ protected String table_row_for( ArrayList< String > colors ) {
      * If the size of columnBodies is less than the number of columns in a row, create the remaining columns
      * with just blank strings.
      *
-     * @param columnStrings ArrayList<String> list of the strings that are the bodies of each of the columns in the row
+     * @param columnStrings ArrayList of String - list of the strings that are the bodies of each of the columns in the row
      *
      * @return String the entire row
      */

diff --git a/...ateDocInfo/src/main/java/com/ashleycaroline/plantuml/generateDocInfo/GeneratorConsts.java b/...ateDocInfo/src/main/java/com/ashleycaroline/plantuml/generateDocInfo/GeneratorConsts.java
@@ -15,8 +15,8 @@
  *  Responsibility: Hold all constant definitions needed for this package/module.
  *
  *
- *  @file GeneratorConsts
- *  @project documentation  (local project name)
+ *  file GeneratorConsts
+ *  project: plantuml-documentation  (local project name)
  *
  *  @author Ashley Engelund   [email protected] | weedySeaDragon@github
  *  @since 02 Oct 2018

diff --git a/...Info/src/main/java/com/ashleycaroline/plantuml/generateDocInfo/PlantUmlInfoGenerator.java b/...Info/src/main/java/com/ashleycaroline/plantuml/generateDocInfo/PlantUmlInfoGenerator.java
@@ -113,9 +113,9 @@ public static void writePUMLColorFiles() throws IOException {
      * | color name           | example                                        |
      * | Grey                 | .. uml:: source/puml/Grey.puml                 |
      *
-     * @param colorNames
+     * @param colorNames The list of names of all of the colors recognized by PlantUML
      *
-     * @throws IOException
+     * @exception  IOException if there is any kind of IO problem writing the files
      */
     public static void writePUMLColorFilesFor( List< String > colorNames ) throws IOException {
 
@@ -284,7 +284,7 @@ public static String getPlantUMLLanguageInfo() {
 
     /**
      *
-     *
+     * @return a Map of PlantUML diagrams and all of the regular expressions for each
      */
     public static Map< String, List< String > > getPlantUMLDiagramRegexPatterns() {
 

diff --git a/generateDocInfo/src/main/java/com/ashleycaroline/plantuml/generateDocInfo/StringPadder.java b/generateDocInfo/src/main/java/com/ashleycaroline/plantuml/generateDocInfo/StringPadder.java
@@ -13,8 +13,8 @@
  *      - given a string, pad it with spaces so that the string is length X
  *
  *
- *  @file StringPadder.java
- *  @project documentation  (local project name)
+ *  file: StringPadder.java
+ *  project: plantuml-documentation  (local project name)
  *
  *  @author Ashley Engelund   [email protected] | weedySeaDragon@github
  *  @since 11 Oct 2018

diff --git a/gradle/wrapper/gradle-wrapper.properties b/gradle/wrapper/gradle-wrapper.properties
@@ -1,6 +1,6 @@
-#Sat Sep 29 19:10:15 PDT 2018
+#Sat Mar 02 05:05:01 PST 2019
 distributionBase=GRADLE_USER_HOME
 distributionPath=wrapper/dists
 zipStoreBase=GRADLE_USER_HOME
 zipStorePath=wrapper/dists
-distributionUrl=https\://services.gradle.org/distributions/gradle-4.10.2-all.zip
+distributionUrl=https\://services.gradle.org/distributions/gradle-5.2.1-all.zip
diff --git a/gradlew b/gradlew
@@ -28,7 +28,7 @@ APP_NAME="Gradle"
 APP_BASE_NAME=`basename "$0"`
 
 # Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
-DEFAULT_JVM_OPTS=""
+DEFAULT_JVM_OPTS='"-Xmx64m"'
 
 # Use the maximum available, or set MAX_FD != -1 to use that value.
 MAX_FD="maximum"

diff --git a/gradlew.bat b/gradlew.bat
@@ -14,7 +14,7 @@ set APP_BASE_NAME=%~n0
 set APP_HOME=%DIRNAME%
 
 @rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
-set DEFAULT_JVM_OPTS=
+set DEFAULT_JVM_OPTS="-Xmx64m"
 
 @rem Find java.exe
 if defined JAVA_HOME goto findJavaFromJavaHome

diff --git a/settings.gradle b/settings.gradle
@@ -1,4 +1,4 @@
-rootProject.name = 'documentation'
+rootProject.name = 'plantuml-documentation'
 
 include 'generateDocInfo'
 
diff --git a/src/main/com/ashleycaroline/sphinxutils/__init__.py b/src/main/com/ashleycaroline/sphinxutils/__init__.py