Add documentation for API usage examples (#42)

Add usage examples in API documentation of functions in mqtt_agent.h

lexicon.txt

@@ -5,11 +5,14 @@ acks
 addacknowledgment
 agentcommandget
 agentcommandrelease
+agentcontext
 agentinterface
 agentmessagecontext
 agentmessageinterface
 agentmessagerecv
 agentmessagesend
+agentreceivemessage
+agentsendmessage
 api
 apis
 appcallback
@@ -22,18 +25,31 @@ bytesorerror
 bytestorecv
 bytestosend
 cbmc
+cleansession
+cleansession
 clearonlysubunsubentries
+clientidentifierlength
+clientidentifierlength
 cmdcompletecallback
+cmdcompletecb
 com
 commandcallback
 commandcompletecallback
 commandcontext
+commandinfo
 commandloop
 commandtype
 cond
 config
 configpagestyle
 connack
+connectargs
+connectcallback
+connectcmdcallback
+connectinfo
+connectionargs
+connectstatus
+connectstatus
 const
 copydoc
 coremqtt
@@ -43,27 +59,35 @@ css
 defgroup
 deserialized
 didn
+disconnectcallback
+disconnectcmdcallback
 doesn
 doxygen
 dup
+endcode
 endcond
 endif
 endloop
 enqueueing
 enum
 enums
+fixedbuffer
+foo
 freertos
 func
 functotest
 gcc
 getcommand
 getcurrenttimems
+gettimestampms
 github
 html
 https
 ifndef
 inc
 incomingcallback
+incomingpacketcontext
+incomingpacketcontext
 incomingpacketid
 incomingpublishcallback
 ingroup
@@ -72,17 +96,22 @@ initalized
 int
 iot
 iso
+keepaliveseconds
+keepaliveseconds
 logdebug
 logerror
 loginfo
 logwarn
+lwt
 mainpage
 memset
+messagecontext
+messageinterface
 metadata
 microcontroller
 min
-mit
 misra
+mit
 mqtt
 mqttagent
 mqttagentcommand
@@ -98,6 +127,7 @@ mqttfixedbuffer
 mqttgetcurrenttimefunc
 mqttkeepalivetimeout
 mqttnomemory
+mqttnotconnected
 mqttpublishinfo
 mqttrecvfailed
 mqttsendfailed
@@ -107,8 +137,11 @@ mqttsubscribeinfo
 mqttsuccess
 multithreaded
 multithreading
+networkbuffer
 networkinterfacereceivestub
 networkinterfacesendstub
+networkrecv
+networksend
 noninfringement
 num
 numsubscriptions
@@ -121,7 +154,13 @@ pagentcontext
 param
 params
 pargs
+passwordlength
+passwordlength
+payloadlength
+payloadlength
 pbuffer
+pclientidentifier
+pclientidentifier
 pcmdcallbackcontext
 pcmdcompletecallbackcontext
 pcmdcontext
@@ -143,6 +182,7 @@ pfuncname
 pincomingcallback
 pincomingcallbackcontext
 pincomingpacketcontext
+pingrequestcompletecb
 pingresp
 pmqttagentcontext
 pmqttcontext
@@ -155,6 +195,10 @@ poriginalcommand
 posix
 ppacketinfo
 pparams
+ppassword
+ppassword
+ppayload
+ppayload
 ppendingacks
 ppublisharg
 ppublishinfo
@@ -167,12 +211,19 @@ psubackcodes
 psubscribeargs
 psubscribeinfo
 psubscriptionargs
+ptopicfilter
+ptopicfilter
+ptopicname
+ptopicname
 ptransportinterface
 puback
 pubcomp
+publishcmdcompletecb
+publishinfo
 pubrec
 pubrel
 punusedarg
+pusername
 pvoidconnectargs
 pvoidsubscribeargs
 pwillinfo
@@ -187,17 +238,38 @@ returnflags
 runprocessloop
 sdk
 sessionpresent
+sizeof
+someclientid
+somepassword
+sometransportcontext
+someusername
 statusreturn
+strlen
 struct
 structs
+stubgettime
+stubpublishcallback
 stubreceive
 stubreceivethenfail
 suback
 sublicense
+subscribeargs
+subscribecmdcompletecb
+subscribeinfo
+terminatecallback
 timeoutms
 todo
+topicfilterlength
+topicnamelength
+transportinterface
 uint
 unsuback
+unsubscribeargs
+unsubscribecmdcompletecb
+unsubscribecompletecb
+unsubscribeinfo
+usernamelength
 utest
 uxcontrolandlengthbytes
+willinfo
 www

manifest.yml

@@ -0,0 +1,11 @@
+name : "coreMQTT Agent"
+version: "v1.0.0"
+description: |
+  "Agent for thread-safe use of coreMQTT.\n"
+dependencies:
+  - name : "coreMQTT"
+    version: "v1.1.0"
+    repository:
+      type: "git"
+      url: "https://github.com/FreeRTOS/coreMQTT/"
+license: "MIT"