Deprecated doc added

jbehave-support-core/README.md

@@ -13,3 +13,4 @@ Core jBehave support.
     - [Health check steps](docs/Health-checks.md)
 - [Reporting](docs/Reporting.md)
 - [Filtering](docs/Filtering.md)
+- [List of deprecated functionality](docs/Deprecated.md)

jbehave-support-core/docs/Deprecated.md

@@ -0,0 +1,166 @@
+[Contents](../README.md)
+
+## Deprecated functionality
+
+### To be removed - do not use
+
+Column _OPERATOR_
+
+>Deprecated since version 1.0.0 - will be removed soon
+>
+>Replaced with column _VERIFIER_
+>
+>Example:
+>```
+>!-- Deprecated example
+>Then the following data are present in [TEST] log:
+>| data      | OPERATOR |
+>| my string | CONTAINS |
+>
+>!-- What should be used instead
+>Then the following data are present in [TEST] log:
+>| data      | VERIFIER |
+>| my string | CONTAINS |
+>```
+
+---
+Class _FirefoxWebDriverFactory_
+
+>Deprecated since version 1.0.0 - will be removed soon
+>
+>Chrome browser should be used instead
+
+---
+Step _Then new tab is opened and focused_
+
+>Deprecated since version 1.0.7 - will be removed in future
+>
+>Use _Then tab with [$urlTitle] containing [$text] is focused_ instead
+>
+>Step focus an already opened tab instead of opening one
+>
+>Example:
+>```
+>!-- Correct usage
+>Given tab with [url] containing [google] is focused
+>```
+>
+---
+4 parameters constructor of class _SshTemplate_
+
+>Deprecated since 1.1.0 - will be removed in future
+>
+>Use 5 parameters constructor instead
+>
+>The new constructor was added due to new implementation of ServerLogReportExtension
+>
+>Example:
+>```
+>\\ Deprecated example
+>SshTemplate myTemplate = new SshTemplate(keySetting, timestampFormat, rollingLogResolver);
+>
+>\\ What should be used instead
+>SshTemplate keyTemplate = new SshTemplate(keySetting, timestampFormat, rollingLogResolver, false);
+>```
+
+---
+Step _Given log timestamp is saved as [$startTimeAlias]_
+
+>Deprecated since version 1.0.10 - will be removed in future
+>
+>Use _Given current time is saved as log timestamp [$logTimeAlias]_ instead
+>
+>New step have adjusted wording
+>
+>Example:
+>```
+>!-- Deprecated example
+>Given log timestamp is saved as [LOG_TIMESTAMP]
+>
+>!-- What should be used instead
+>Given current time is saved as log timestamp [LOG_TIMESTAMP]
+>```
+
+---
+Step _Then the following data are present in [$systemQualifier] log since [$startTimeAlias]:$presentData_
+
+>Deprecated since version 1.0.9 - will be removed in future
+>
+>Use _Then the following data are present in [$systemQualifier] log:$presentData"_ instead
+>
+>New step works better with timestamps
+>
+>Example:
+>```
+>!-- Deprecated example
+>Given current time is saved as log timestamp [LOG_TIMESTAMP]
+>
+>When [PATCH] request to [TEST]/[init/] is sent
+>Then response from [TEST] REST API has status [OK]
+>
+>Then the following data are present in [$systemQualifier] log since [LOG_TIMESTAMP]:
+>| data      | VERIFIER |
+>| my string | CONTAINS |
+>
+>!-- What should be used instead
+>Given log start timestamp is set to current time
+>
+>When [PATCH] request to [TEST]/[init/] is sent
+>Then response from [TEST] REST API has status [OK]
+>
+>Given log end timestamp is set to current time
+>
+>Then the following data are present in [TEST] log:
+>| data      | VERIFIER |
+>| my string | CONTAINS |
+>
+>```
+>
+>Method _SshHandler.checkLogDataPresence(String systemQualifier, String startTimeAlias, String stringTable, Verifier verifier)_ will be deleted too
+
+---
+Step _Then the following data are not present in [$systemQualifier] log:$missingData_
+
+>Deprecated since version 1.0.10 - will be removed in future
+>
+>Use _Then the following data are present in [$systemQualifier] log:$presentData"_ instead
+>
+>Verifier _NOT_CONTAINS_ should be used instead of whole step
+>
+>Example:
+>```
+>!-- What should be used instead
+>Given log start timestamp is set to current time
+>
+>When [PATCH] request to [TEST]/[init/] is sent
+>Then response from [TEST] REST API has status [OK]
+>
+>Given log end timestamp is set to current time
+>
+>Then the following data are not present in [TEST] log:
+>| data           |
+>| missing string |
+>
+>!-- What should be used instead
+>Given log start timestamp is set to current time
+>
+>When [PATCH] request to [TEST]/[init/] is sent
+>Then response from [TEST] REST API has status [OK]
+>
+>Given log end timestamp is set to current time
+>
+>Then the following data are present in [TEST] log:
+>| data           | VERIFIER     |
+>| missing string | NOT_CONTAINS |
+>
+>```
+
+### To be rewritten - do not use
+
+_WebTableSteps_
+>Deprecated since 1.1.0 - won't be removed but adjusted
+>
+>Those steps will be rewritten in future
+
+### Already removed
+>_none yet_

jbehave-support-core/src/main/java/org/jbehavesupport/core/ssh/SshTemplate.java

@@ -46,7 +46,7 @@ private abstract static class Constants {
     }
 
     /**
-     * @deprecated
+     * @deprecated(since = "1.1.0", forRemoval = true)
      * use {@link #SshTemplate(SshSetting, String, RollingLogResolver, boolean)} instead
      */
     @Deprecated