Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
16 changes: 8 additions & 8 deletions docs/doxygen/developer/developer.dox
Original file line number Diff line number Diff line change
@@ -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 <br>
@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 <br>
@copybrief guide_developer_styleguide
*/
126 changes: 63 additions & 63 deletions docs/doxygen/images/http_demo_plaintext.pu
Original file line number Diff line number Diff line change
@@ -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