diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 3175e6d669..f79d157ffa 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -140,6 +140,16 @@ jobs: else exit 0 fi + - name: Check for CRLF + run: | + set +e + find . -path ./.git -prune -o -exec file {} + | grep "CRLF" + if [ "$?" = "0" ]; then + echo "Files have CRLF line endings." + exit 1 + else + exit 0 + fi doxygen: runs-on: ubuntu-20.04 steps: diff --git a/docs/doxygen/developer/developer.dox b/docs/doxygen/developer/developer.dox index bf06c14296..46e88dd5ba 100644 --- a/docs/doxygen/developer/developer.dox +++ b/docs/doxygen/developer/developer.dox @@ -1,8 +1,8 @@ -/** -@page guide_developer Developer's Guide -@brief Guide for maintaining and contributing code to this project. - -This guide contains the following pages. All pages assume the reader has intermediate familiarity with this SDK. -- @subpage guide_developer_styleguide
- @copybrief guide_developer_styleguide -*/ +/** +@page guide_developer Developer's Guide +@brief Guide for maintaining and contributing code to this project. + +This guide contains the following pages. All pages assume the reader has intermediate familiarity with this SDK. +- @subpage guide_developer_styleguide
+ @copybrief guide_developer_styleguide +*/ diff --git a/docs/doxygen/images/http_demo_plaintext.pu b/docs/doxygen/images/http_demo_plaintext.pu index aaae4a3de9..cbebb94ccc 100644 --- a/docs/doxygen/images/http_demo_plaintext.pu +++ b/docs/doxygen/images/http_demo_plaintext.pu @@ -1,63 +1,63 @@ -@startuml -skinparam dpi 300 -skinparam classFontSize 8 -skinparam classFontName Helvetica -autonumber - -box "Application" #LightGreen - participant "Application" as application -end box - -box "Libraries" #LightBlue - participant "HTTP Client" as http -end box - -box "HTTP Server" #Yellow - participant "HTTP Server" as server -end box - -activate application -loop until session established or all attempts exhausted -application -> server : Establish TCP session -server -> application : Session established -end - -application -> application: Set request info parameters -application -> http: Initialize request headers (HTTPClient_InitializeRequestHeaders) -activate http -http -> application : Write request headers to user-provided buffer -deactivate http - -application -> http: Send HTTP GET request (HTTPClient_Send) -activate http -http -> server: Send payload of request through transport interface -http -> application : Write response to user-provided buffer -application -> application: Log response from contents of buffer -deactivate http - -application -> http: Send HTTP HEAD request (HTTPClient_Send) -activate http -http -> server: Send payload of request through transport interface -http -> application : Write response to user-provided buffer -application -> application: Log response from contents of buffer -deactivate http - -application -> http: Send HTTP PUT request (HTTPClient_Send) -activate http -http -> server: Send payload of request through transport interface -http -> application : Write response to user-provided buffer -application -> application: Log response from contents of buffer -deactivate http - -application -> http: Send HTTP POST request (HTTPClient_Send) -activate http -http -> server: Send payload of request through transport interface -http -> application : Write response to user-provided buffer -application -> application: Log response from contents of buffer -deactivate http - -application -> server: End TCP session and disconnect from server - -deactivate application - -@enduml +@startuml +skinparam dpi 300 +skinparam classFontSize 8 +skinparam classFontName Helvetica +autonumber + +box "Application" #LightGreen + participant "Application" as application +end box + +box "Libraries" #LightBlue + participant "HTTP Client" as http +end box + +box "HTTP Server" #Yellow + participant "HTTP Server" as server +end box + +activate application +loop until session established or all attempts exhausted +application -> server : Establish TCP session +server -> application : Session established +end + +application -> application: Set request info parameters +application -> http: Initialize request headers (HTTPClient_InitializeRequestHeaders) +activate http +http -> application : Write request headers to user-provided buffer +deactivate http + +application -> http: Send HTTP GET request (HTTPClient_Send) +activate http +http -> server: Send payload of request through transport interface +http -> application : Write response to user-provided buffer +application -> application: Log response from contents of buffer +deactivate http + +application -> http: Send HTTP HEAD request (HTTPClient_Send) +activate http +http -> server: Send payload of request through transport interface +http -> application : Write response to user-provided buffer +application -> application: Log response from contents of buffer +deactivate http + +application -> http: Send HTTP PUT request (HTTPClient_Send) +activate http +http -> server: Send payload of request through transport interface +http -> application : Write response to user-provided buffer +application -> application: Log response from contents of buffer +deactivate http + +application -> http: Send HTTP POST request (HTTPClient_Send) +activate http +http -> server: Send payload of request through transport interface +http -> application : Write response to user-provided buffer +application -> application: Log response from contents of buffer +deactivate http + +application -> server: End TCP session and disconnect from server + +deactivate application + +@enduml