Doc: Fix various Codacy formatting issues

Lemgoer · Jan 2, 2019 · aa3c4be · aa3c4be
1 parent 4d60ed9
commit aa3c4be
Show file tree

Hide file tree

Showing 8 changed files with 89 additions and 214 deletions.
diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md
@@ -8,19 +8,19 @@ In the interest of fostering an open and welcoming environment, we as contributo
 
 Examples of behavior that contributes to creating a positive environment include:
 
-* Using welcoming and inclusive language
-* Being respectful of differing viewpoints and experiences
-* Gracefully accepting constructive criticism
-* Focusing on what is best for the community
-* Showing empathy towards other community members
+- Using welcoming and inclusive language
+- Being respectful of differing viewpoints and experiences
+- Gracefully accepting constructive criticism
+- Focusing on what is best for the community
+- Showing empathy towards other community members
 
 Examples of unacceptable behavior by participants include:
 
-* The use of sexualized language or imagery and unwelcome sexual attention or advances
-* Trolling, insulting/derogatory comments, and personal or political attacks
-* Public or private harassment
-* Publishing others' private information, such as a physical or electronic address, without explicit permission
-* Other conduct which could reasonably be considered inappropriate in a professional setting
+- The use of sexualized language or imagery and unwelcome sexual attention or advances
+- Trolling, insulting/derogatory comments, and personal or political attacks
+- Public or private harassment
+- Publishing others' private information, such as a physical or electronic address, without explicit permission
+- Other conduct which could reasonably be considered inappropriate in a professional setting
 
 ## Our Responsibilities
 

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -75,9 +75,9 @@ The following points will be especially looked at during the review.
 
 These labels can be used for the PR title to indicate its status.
 
-- [WIP]: The PR is work in progress and at this point simply informative.
-- [Review]: The PR is ready from the developers perspective. He requests a review from a core-maintainer.
-- [Discussion]: The PR is a contribution to ongoing technical discussions. The PR may be incomplete and is not intended to be merged before the discussion has concluded.
+- `[WIP]`: The PR is work in progress and at this point simply informative.
+- `[Review]`: The PR is ready from the developers perspective. He requests a review from a core-maintainer.
+- `[Discussion]`: The PR is a contribution to ongoing technical discussions. The PR may be incomplete and is not intended to be merged before the discussion has concluded.
 
 The core-maintainers are busy people. If they take especially long to react,
 feel free to trigger them by additional comments in the PR thread. Again, small

diff --git a/FEATURES.md b/FEATURES.md
@@ -4,27 +4,27 @@ open62541 Supported Features
 OPC UA Stack
 ------------
 
-|                                         |                      |                      |
-| --------------------------------------- |:--------------------:| -------------------- |
-| **Encoding **                           |                      |                      |
-| OPC UA Binary                           |  :heavy_check_mark:  |                      |
-| OPC UA JSON                             |      :new_moon:      | WIP for Release 0.4  |
-| OPC UA XML                              |      :new_moon:      |                      |
-| **Transport**                           |                      |                      |
-| UA-TCP UA-SC UA Binary                  |  :heavy_check_mark:  |                      |
-| OPC UA HTTPS                            |      :new_moon:      |                      |
-| SOAP-HTTP WS-SC UA Binary               |      :new_moon:      |                      |
-| SOAP-HTTP WS-SC UA XML                  |      :new_moon:      |                      |
-| SOAP-HTTP WS-SC UA XML-UA Binary        |      :new_moon:      |                      |
-| **Encryption**                          |                      |                      |
-| None                                    |  :heavy_check_mark:  |                      |
-| Basic128Rsa15                           |  :heavy_check_mark:  | master, Release 0.3  |
-| Basic256                                |  :heavy_check_mark:  | master, Release 0.3  |
-| Basic256Sha256                          |  :heavy_check_mark:  | master, Release 0.3  |
-| **Authentication**                      |                      |                      |
-| Anonymous                               |  :heavy_check_mark:  |                      |
-| User Name Password                      |  :heavy_check_mark:  |                      |
-| X509 Certificate                        |      :new_moon:      |                      |
+|                                         |                    |                      |
+| --------------------------------------- |:------------------:| -------------------- |
+| **Encoding**                            |                    |                      |
+| OPC UA Binary                           | :heavy_check_mark: |                      |
+| OPC UA JSON                             |     :new_moon:     | WIP for Release 0.4  |
+| OPC UA XML                              |     :new_moon:     |                      |
+| **Transport**                           |                    |                      |
+| UA-TCP UA-SC UA Binary                  | :heavy_check_mark: |                      |
+| OPC UA HTTPS                            |     :new_moon:     |                      |
+| SOAP-HTTP WS-SC UA Binary               |     :new_moon:     |                      |
+| SOAP-HTTP WS-SC UA XML                  |     :new_moon:     |                      |
+| SOAP-HTTP WS-SC UA XML-UA Binary        |     :new_moon:     |                      |
+| **Encryption**                          |                    |                      |
+| None                                    | :heavy_check_mark: |                      |
+| Basic128Rsa15                           | :heavy_check_mark: | master, Release 0.3  |
+| Basic256                                | :heavy_check_mark: | master, Release 0.3  |
+| Basic256Sha256                          | :heavy_check_mark: | master, Release 0.3  |
+| **Authentication**                      |                    |                      |
+| Anonymous                               | :heavy_check_mark: |                      |
+| User Name Password                      | :heavy_check_mark: |                      |
+| X509 Certificate                        |     :new_moon:     |                      |
 
 OPC UA Server
 -------------
@@ -55,8 +55,8 @@ OPC UA Server
 |                             | QueryNext()                     |      :new_moon:      |                      |
 | Attribute Service Set       | Read()                          |  :heavy_check_mark:  |                      |
 |                             | Write()                         |  :heavy_check_mark:  |                      |
-|                             | HistoryRead()                   | :waning_gibbous_moon: | [WIP](https://github.com/open62541/open62541/pull/1740), Release 0.4     |
-|                             | HistoryUpdate()                 | :waning_gibbous_moon: | [WIP](https://github.com/open62541/open62541/pull/1740), Release 0.4     |
+|                             | HistoryRead()                   | :waning_gibbous_moon: | [WIP](https://github.com/open62541/open62541/pull/1740), Release 0.4 |
+|                             | HistoryUpdate()                 | :waning_gibbous_moon: | [WIP](https://github.com/open62541/open62541/pull/1740), Release 0.4 |
 | Method Service Set          | Call()                          |  :heavy_check_mark:  |                      |
 | MonitoredItems Service Set  | CreateMonitoredItems()          |  :heavy_check_mark:  | See below for Events |
 |                             | DeleteMonitoredItems()          |  :heavy_check_mark:  |                      |
@@ -71,18 +71,18 @@ OPC UA Server
 |                             | DeleteSubscriptions()           |  :heavy_check_mark:  |                      |
 |                             | TransferSubscriptions()         |      :new_moon:      |                      |
 
-| **Subscriptions**                       |                      |                      |
-| --------------------------------------- |:--------------------:| -------------------- |
-| DataChange MonitoredItems               |  :heavy_check_mark:  | master, Release 0.3  |
-| DataChange Filters                      |  :heavy_check_mark:  | master               |
-| Event MonitoredItems                    |  :heavy_check_mark:  | master               |
-| Event Filters                           |      :new_moon:      |                      |
+| **Subscriptions**                       |                    |                      |
+| --------------------------------------- |:------------------:| -------------------- |
+| DataChange MonitoredItems               | :heavy_check_mark: | master, Release 0.3  |
+| DataChange Filters                      | :heavy_check_mark: | master               |
+| Event MonitoredItems                    | :heavy_check_mark: | master               |
+| Event Filters                           |     :new_moon:     |                      |
 
-| **Discovery**                           |                      | See Discovery Service Set |
-| --------------------------------------- |:--------------------:| -------------------- |
-| Local Disovery Server                   |  :heavy_check_mark:  | master, Release 0.3  |
-| Local Discovery Server Multicast Ext.   |  :heavy_check_mark:  | master, Release 0.3  |
-| Global Discovery Server                 |      :new_moon:      |                      |
+| **Discovery**                           |                    | See Discovery Service Set |
+| --------------------------------------- |:------------------:| -------------------- |
+| Local Disovery Server                   | :heavy_check_mark: | master, Release 0.3  |
+| Local Discovery Server Multicast Ext.   | :heavy_check_mark: | master, Release 0.3  |
+| Global Discovery Server                 |     :new_moon:     |                      |
 
 OPC UA Client
 -------------

diff --git a/ISSUE_TEMPLATE.md b/ISSUE_TEMPLATE.md
@@ -13,17 +13,12 @@ Fill out the sections and checklist below (add text at the end of each line).
 --------------------------------------------------------------------------------
 -->
 
-Description
-===========
+## Description
 
+## Background Information / Reproduction Steps
 
-Background Information / Reproduction Steps
-===========================================
+## Checklist
 
-
-
-Checklist
-=========
 Please provide the following information:
 
  - [ ] open62541 Version (release number or git tag):

diff --git a/README.md b/README.md
@@ -1,12 +1,13 @@
-open62541
-=========
+# open62541
 
-open62541 (http://open62541.org) is an open source and free implementation of OPC UA (OPC Unified Architecture) written in the common subset of the C99 and C++98 languages. The library is usable with all major compilers and provides the necessary tools to implement dedicated OPC UA clients and servers, or to integrate OPC UA-based communication into existing applications. open62541 library is platform independent. All platform-specific functionality is implemented via exchangeable plugins. Plugin implementations are provided for the major operating systems.
+open62541 (<http://open62541.org>) is an open source and free implementation of OPC UA (OPC Unified Architecture) written in the common subset of the C99 and C++98 languages. The library is usable with all major compilers and provides the necessary tools to implement dedicated OPC UA clients and servers, or to integrate OPC UA-based communication into existing applications. open62541 library is platform independent. All platform-specific functionality is implemented via exchangeable plugins. Plugin implementations are provided for the major operating systems.
 
 open62541 is licensed under the Mozilla Public License v2.0. So the *open62541 library can be used in projects that are not open source*. Only changes to the open62541 library itself need to published under the same license. The plugins, as well as the server and client examples are in the public domain (CC0 license). They can be reused under any license and changes do not have to be published.
 
 The library is [available](https://github.com/open62541/open62541/releases) in standard source and binary form. In addition, the single-file source distribution merges the entire library into a single .c and .h file that can be easily added to existing projects. Example server and client implementations can be found in the [/examples](examples/) directory or further down on this page.
 
+## Project Information
+
 Build Status:
 
 [![Build Status](https://img.shields.io/travis/open62541/open62541/master.svg)](https://travis-ci.org/open62541/open62541)
@@ -16,17 +17,16 @@ Code Quality:
 
 [![Codacy Badge](https://api.codacy.com/project/badge/Grade/68ad08e897624c77a64fc2be66ca7b50)](https://www.codacy.com/app/open62541/open62541?utm_source=github.com&amp;utm_medium=referral&amp;utm_content=open62541/open62541&amp;utm_campaign=Badge_Grade)
 [![Total Alerts](https://img.shields.io/lgtm/alerts/g/open62541/open62541.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/open62541/open62541/alerts)
-
 [![Coverity Scan Build Status](https://img.shields.io/coverity/scan/12248.svg)](https://scan.coverity.com/projects/open62541-open62541)
 [![Coverage Status](https://img.shields.io/coveralls/open62541/open62541/master.svg)](https://coveralls.io/r/open62541/open62541?branch=master)
-
 [![Code Quality: Cpp](https://img.shields.io/lgtm/grade/cpp/g/open62541/open62541.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/open62541/open62541/context:cpp)
 
 General Project Info:
 
 [![Ohloh Project Status](https://www.ohloh.net/p/open62541/widgets/project_thin_badge.gif)](https://www.ohloh.net/p/open62541)
 [![Overall Downloads](https://img.shields.io/github/downloads/open62541/open62541/total.svg)](https://github.com/open62541/open62541/releases)
 
+
 ### Features
 
 For a complete list of features check: [open62541 Features](FEATURES.md)
@@ -97,6 +97,8 @@ Jointly with the overall open62541 community, the core maintainers steer the lon
 - Julius Pfrommer (Fraunhofer IOSB, Karlsruhe)
 - Stefan Profanter (fortiss, Munich)
 
+## Support & Development
+
 ### Commercial Support
 
 The open62541 community handles support requests for the open source library and its development. Custom development and individual support is provided by commercial partners that are affiliated with open62541:
@@ -114,6 +116,8 @@ As an open source project, new contributors are encouraged to help improve open6
 - Improve the [documentation](http://open62541.org/doc/current)
 - Work on issues marked as "[good first issue](https://github.com/open62541/open62541/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22)"
 
+## Examples
+
 ### Example Server Implementation
 Compile the examples with the single-file distribution `open62541.h/.c` header and source file.
 Using the GCC compiler, just run ```gcc -std=c99 -DUA_ARCHITECTURE_POSIX <server.c> open62541.c -o server``` (under Windows you may need to add ``` -lws2_32``` 

diff --git a/arch/Readme.md b/arch/Readme.md
@@ -1,8 +1,19 @@
-# To port to a new architecture you should follow this file:
+# open62541 Architectures 
+
+The `arch` folder contains all the architecture-specific code for a given operating system.
+
+The list of supported architectures is also available as a CMake option.
+
+## Adding new architectures
+
+To port to a new architecture you should follow these steps:
 
 1. Create a folder with your architecture, let's call it new_arch
+
 2. In the CMakeLists.txt file located next to this file, add `add_subdirectory(new_arch)` at the end of it
+
 3. Create a CMakeLists.txt file in the new_arch folder
+
 4. Use the following template for it (remember that when you see new_arch you should replace with the name of your architecture)
     ```C
     # ---------------------------------------------------
@@ -39,15 +50,19 @@
     ```
 5. Create a ua_clock.c file that implements the following functions defined in ua_types.h:
 
-    UA_DateTime UA_DateTime_now(void);
-    UA_Int64 UA_DateTime_localTimeUtcOffset(void);
-    UA_DateTime UA_DateTime_nowMonotonic(void);
+   * UA_DateTime UA_DateTime_now(void);
+
+   * UA_Int64 UA_DateTime_localTimeUtcOffset(void);
+
+   * UA_DateTime UA_DateTime_nowMonotonic(void);
 
 6. Create a file in the folder new_arch called ua_architecture.h
 
-7. Use the following template for it:
-  a: Change YEAR, YOUR_NAME and YOUR_COMPANY in the header
-  b: Change NEW_ARCH at the beginning in PLUGINS_ARCH_NEW_ARCH_UA_ARCHITECTURE_H_ for your own name in uppercase
+7. Use the following template for it:  
+
+   * Change YEAR, YOUR_NAME and YOUR_COMPANY in the header
+
+   * Change NEW_ARCH at the beginning in PLUGINS_ARCH_NEW_ARCH_UA_ARCHITECTURE_H_ for your own name in uppercase  
 
     ```C
     /* This work is licensed under a Creative Commons CCZero 1.0 Universal License.

diff --git a/tests/fuzz/README.md b/tests/fuzz/README.md
@@ -7,12 +7,12 @@ https://github.com/google/oss-fuzz
 Currently tested is processing of binary messages and encoding/decoding of
 binary encoded data.
 
-# Status
+## Status
 
 * [Build status](https://oss-fuzz-build-logs.storage.googleapis.com/index.html)
 * [Open issues](https://bugs.chromium.org/p/oss-fuzz/issues/list?q=label:Proj-open62541)
 
-# Update the corpus
+## Update the corpus
 
 To update the current corpus used for fuzzing you need to follow these steps.
 It will execute all the unit tests, dump the received data packages to a directory
@@ -32,4 +32,4 @@ and then update and merge the corpus.
 
    `open62541/fuzz/fuzz_binary_message_corpus/generated`
 
-   Commit the new files and then you can delete the build directories created in step 1.
+   Commit the new files and then you can delete the build directories created in step 1.