Docs.

Author: samharrison7

CHANGELOG.md

@@ -0,0 +1,20 @@
+# Changelog
+Notable changes to the Fortran Error Handler will be documented here.
+
+## [Unreleased]
+
+## [1.0.1] - 2020-06-30
+### Added
+- Option to turn off printing of non-critical (warning) errors on trigger. Configured by `triggerWarnings` parameter on `ErrorHandler%init(...)`.
+- This CHANGELOG.
+
+### Fixed
+- A few corrections to documentation.
+
+## [1.0] - 2020-06-05
+### Added
+- First major release.
+
+[Unreleased]: https://github.com/samharrison7/fortran-error-handler/compare/1.0.1...HEAD
+[1.0.1]: https://github.com/samharrison7/fortran-error-hander/compare/v1.0...v1.0.1
+[1.0]: https://github.com/samharrison7/fortran-error-hander/compare/v0.3-beta2...v1.0

doc/ErrorCriteria.md

@@ -33,7 +33,7 @@ Initialising ErrorCriteria serves the purpose of [initialising its parent](Error
 | `character(len=*), optional :: criticalPrefix` | Custom prefix to be prepended to critical error messages. | "Error:" |
 | `character(len=*), optional :: warningPrefix` | Custom prefix to non-critical (warning) error messages. | "Warning:" |
 | `character(len=*), optional :: messageSuffix` | Custom suffix to be appended to error message. | - |
-| `logical, optional :: bashColors` | Should colors be displayed in output to bash consoles? | .true. |
+| `logical, optional :: bashColors` | Should colors be displayed in output to bash consoles? | `.true.` |
 
 For example:
 

doc/ErrorHandler.md

@@ -52,7 +52,7 @@ For single errors, `add` acts as a generic to the ErrorHandler's `addErrorInstan
 | :--- | :--- | :--- |
 | `integer, optional :: code` | Error code to add. | - |
 | `character(len=*), optional :: message` | Message for the error. | "" |
-| `logical, optional :: isCritical` | Is the error critical? | .true. |
+| `logical, optional :: isCritical` | Is the error critical? | `.true.` |
 | `type(ErrorInstance), optional :: error` | ErrorInstance to add, if a code hasn't been specified. | - |
 
 For example:
@@ -69,7 +69,7 @@ For multiple errors input as an array of codes and optional messages and areCrit
 | :--- | :--- | :--- |
 | `integer :: codes(:)` | Array of error codes to add. | - |
 | `character(len=*), optional :: messages(:)` | Corresponding messages for the errors. | "" |
-| `logical, optional :: areCritical(:)` | Are the errors critical? | .true. |
+| `logical, optional :: areCritical(:)` | Are the errors critical? | `.true.` |
 
 For example:
 

doc/ErrorInstance.md

@@ -14,9 +14,9 @@ An `ErrorInstance(code, message, isCritical, trace)` interface is provided so th
 
 | Parameter declaration | Description | Default |
 | :--- | :--- | :--- |
-| `integer, optional :: code` | The error code. | 1 |
-| `character(len=*), optional :: message` | Default message for the error (which there is plenty of opportunity to override). | "" |
-| `logical, optional :: isCritical` | Is the error critical (i.e., should it stop the program)? | .true. |
+| `integer, optional :: code` | The error code. | `1` |
+| `character(len=*), optional :: message` | Default message for the error (which there is plenty of opportunity to override). | `""` |
+| `logical, optional :: isCritical` | Is the error critical (i.e., should it stop the program)? | `.true.` |
 | `character(len=*), optional :: trace(:)` | Custom trace for the error | - |
 
 For example: