Travic CI with build javadocs

Bartosz-Gorka-Archive · Jan 6, 2018 · 5712e51 · 5712e51
1 parent 9881ddc
commit 5712e51
Show file tree

Hide file tree

Showing 3 changed files with 17 additions and 17 deletions.
diff --git a/.travis.yml b/.travis.yml
@@ -5,16 +5,16 @@ script:
 - mvn cobertura:cobertura
 - mvn javadoc:javadoc
 after_success:
+- cd target/site/apidocs && zip -r javadocs-1.0-SNAPSHOT.zip * && cd ../../..
 - bash <(curl -s https://codecov.io/bash)
 deploy:
   provider: releases
   skip_cleanup: true
   api_key:
     secure: V77FujAsyvI8xwJg/w2o4SVTTcpWHq436w6zvUfXvowSo1F0t+UaI9FkLC8tpUtcx+w/qxYr6FCnQ0r75Bk2RqjQcNIletscd6FCl+vvIlOiZnLWY2YINaPSNAkpgs3KtQb5yfaGgvXqq2qx4y3nUsp2KI/sXTbTtD8ooGw9yiu/t7dgJGEq4xFXw1IkcCJKLH62u4YbVHzinpMajuZSJnpx+tlTMOfMxptHRqZG2lq6zWLH3/7Fk3yWtnijEoaDR1hnse2NZHPb/h3iidYxYLIiu+estZa03rd2Suz3ci6urnR9pjdi9CIRiyH7GLPurRMzFhYLvPOB2185C/7kTPSaEmMLdV7WrBwqGiEFQ/wH7oDi0lfHa7wU1kL5CT/opqeidrSNovowfk/M6TqJ1FNUN9VO1dBLsbLX9152eU9RbXxvmLegRyF6dtn445Y8OLEC2CN52PEQb76GOc+WK2nKnJxjxTIbLy8PZoA3LKJq7cCG/VuZDXJ2s5jD4Z4Ru5lewaRpLah4L4yFqF6SyBrmsn9iddsCro7Ol1Kelzr0hiPeyZw4AJ+HvVGTsE7x2K7FnjVlPWq0IoCW4ygys1UdKivUQf415KrDSDM8OUuVedqakPcliHQy1RPHmIQrg9NGAOaurDdw2ZiPlPkc9awZg47fKQKwAciFfNyJXLI=
-  file_glob: true
   file:
     - target/put.io.black.java-1.0-SNAPSHOT.jar
-    - target/site/apidocs/*
+    - target/site/apidocs/javadocs-1.0-SNAPSHOT.zip
   on:
     repo: bartoszgorka/BlackIO
     tags: true
diff --git a/src/main/java/put/io/black/java/logic/ScenarioManager.java b/src/main/java/put/io/black/java/logic/ScenarioManager.java
@@ -26,7 +26,7 @@ public class ScenarioManager {
 
     /**
      * Method which splits whole text to steps, extracts the actors in the scenario and builds the structure of the tree
-     * @param scenario - Long scenario text lines separated \n
+     * @param scenario Long scenario text lines separated \n
      */
     public ScenarioManager(String scenario) {
         String[] scenarioLines = scenario.split("\n");
@@ -37,16 +37,16 @@ public ScenarioManager(String scenario) {
 
     /**
      * Defines the actors given in the script header
-     * @param header - Scenario header to fetch actors
+     * @param header Scenario header to fetch actors
      */
     private void pullOutActors(String header) {
         actors = header.split(",");
     }
 
     /**
      * Verify if the line starts with the keyword
-     * @param line - single step from scenario
-     * @return true if line starts with keyword or false if not
+     * @param line Single step from scenario
+     * @return True if line starts with keyword or false if not
      */
     public boolean lineStartFromKeyWord(String line) {
         String lineWithoutTabs = line.replace("\t", "");
@@ -60,8 +60,8 @@ public boolean lineStartFromKeyWord(String line) {
 
     /**
      * Determine the nesting of a scenario step
-     * @param line - single step from scenario
-     * @return the number of tab characters in a given step
+     * @param line Single step from scenario
+     * @return The number of tab characters in a given step
      */
     public int countTabSign(String line) {
         String[] words = line.split("\t");
@@ -70,7 +70,7 @@ public int countTabSign(String line) {
 
     /**
      * Build a tree structure of scenario
-     * @param scenarioLines - string array, step in the scenario
+     * @param scenarioLines String array, step in the scenario
      */
     private void buildTreeStructure(String[] scenarioLines) {
         if (scenarioLines.length > 1) {
@@ -105,7 +105,7 @@ private void buildTreeStructure(String[] scenarioLines) {
 
     /**
      * Count scenario nesting level
-     * @return level of scenario nesting
+     * @return Level of scenario nesting
      */
     public int countScenarioNesting() {
         int maxNesting = 1;
@@ -128,7 +128,7 @@ public int countScenarioNesting() {
      * Search maximum nesting level from nodes
      * @param node Node to check
      * @param maxNestingLevel Actual max nesting level
-     * @return nesting level for node
+     * @return Nesting level for node
      */
     private int searchTheNestingNode(Node node, int maxNestingLevel) {
         if (node.hasChildren()) {
@@ -166,7 +166,7 @@ public int countNumberOfScenarioSteps() {
      * Search steps in node
      * @param node Node to check
      * @param scenarioSteps Scenario steps
-     * @return scenario steps to find a node
+     * @return Scenario steps to find a node
      */
     private int searchTheNode(Node node, int scenarioSteps) {
         if (node.hasChildren()) {
@@ -212,8 +212,8 @@ private int searchTheKeyWordsNode(Node node, int keyWordsInScenario) {
     }
 
     /**
-     *
-     * @return scenario without actors
+     * Cut actors from scenario text
+     * @return Scenario without actors
      */
     public String cutActorsFromScenario() {
         LinkedList<String> scenarioWithoutActors = new LinkedList<>();
@@ -232,7 +232,7 @@ public String cutActorsFromScenario() {
     /**
      * Validate lines in scenario. Require lines with actors
      * @param node Node to check
-     * @param scenarioWithoutActors  Scenario lines without actors
+     * @param scenarioWithoutActors Scenario lines without actors
      */
     private void searchLineWithoutActors(Node node, LinkedList<String> scenarioWithoutActors) {
         if (lineNotStartFromActor(node.getLine())) {
@@ -249,7 +249,7 @@ private void searchLineWithoutActors(Node node, LinkedList<String> scenarioWitho
     /**
      * Check line not start from actor
      * @param line Line to check
-     * @return false if line start from actor and true if not
+     * @return False if line start from actor and true if not
      */
     private boolean lineNotStartFromActor(String line) {
         String[] words = line.split(" ");

diff --git a/src/main/java/put/io/black/java/logic/Visitable.java b/src/main/java/put/io/black/java/logic/Visitable.java
@@ -8,7 +8,7 @@ public interface Visitable {
 
     /**
      * Accept visitor check
-     * @param visitor Visitor - guess
+     * @param visitor Visitor - guest
      */
     public void accept(Visitor visitor);
 }