Generated documents and arduino package

lexus2k · Sep 13, 2016 · 1417aea · 1417aea
1 parent 0e86bb6
commit 1417aea
Show file tree

Hide file tree

Showing 12 changed files with 14 additions and 46 deletions.
diff --git a/doc/html/TinyProtocol_8h.html b/doc/html/TinyProtocol_8h.html
@@ -102,8 +102,6 @@
 Include dependency graph for TinyProtocol.h:</div>
 <div class="dyncontent">
 <div class="center"><img src="TinyProtocol_8h__incl.png" border="0" usemap="#src_2arduino_2src_2TinyProtocol_8h" alt=""/></div>
-<map name="src_2arduino_2src_2TinyProtocol_8h" id="src_2arduino_2src_2TinyProtocol_8h">
-</map>
 </div>
 </div>
 <p><a href="TinyProtocol_8h_source.html">Go to the source code of this file.</a></p>

diff --git a/doc/html/tiny__layer2_8h.html b/doc/html/tiny__layer2_8h.html
@@ -106,8 +106,6 @@
 Include dependency graph for tiny_layer2.h:</div>
 <div class="dyncontent">
 <div class="center"><img src="tiny__layer2_8h__incl.png" border="0" usemap="#inc_2tiny__layer2_8h" alt=""/></div>
-<map name="inc_2tiny__layer2_8h" id="inc_2tiny__layer2_8h">
-</map>
 </div>
 </div>
 <p><a href="tiny__layer2_8h_source.html">Go to the source code of this file.</a></p>

diff --git a/doc/latex/TinyProtocol_8h.tex b/doc/latex/TinyProtocol_8h.tex
@@ -7,8 +7,7 @@
 
 {\ttfamily \#include \char`\"{}proto/tiny\+\_\+layer2.\+h\char`\"{}}\\*
 {\ttfamily \#include $<$Hardware\+Serial.\+h$>$}\\*
-Include dependency graph for Tiny\+Protocol.\+h\+:
-\nopagebreak
+Include dependency graph for Tiny\+Protocol.\+h\+:\nopagebreak
 \begin{figure}[H]
 \begin{center}
 \leavevmode

diff --git a/doc/latex/dir_3e42aa6796a3a78f57885b4cb0673062.tex b/doc/latex/dir_3e42aa6796a3a78f57885b4cb0673062.tex
@@ -1,7 +1,6 @@
 \hypertarget{dir_3e42aa6796a3a78f57885b4cb0673062}{}\section{src/arduino Directory Reference}
 \label{dir_3e42aa6796a3a78f57885b4cb0673062}\index{src/arduino Directory Reference@{src/arduino Directory Reference}}
-Directory dependency graph for arduino\+:
-\nopagebreak
+Directory dependency graph for arduino\+:\nopagebreak
 \begin{figure}[H]
 \begin{center}
 \leavevmode

diff --git a/doc/latex/dir_68267d1309a1af8e8297ef4c3efbcdba.tex b/doc/latex/dir_68267d1309a1af8e8297ef4c3efbcdba.tex
@@ -1,7 +1,6 @@
 \hypertarget{dir_68267d1309a1af8e8297ef4c3efbcdba}{}\section{src Directory Reference}
 \label{dir_68267d1309a1af8e8297ef4c3efbcdba}\index{src Directory Reference@{src Directory Reference}}
-Directory dependency graph for src\+:
-\nopagebreak
+Directory dependency graph for src\+:\nopagebreak
 \begin{figure}[H]
 \begin{center}
 \leavevmode

diff --git a/doc/latex/dir_c85d3e3c5052e9ad9ce18c6863244a25.tex b/doc/latex/dir_c85d3e3c5052e9ad9ce18c6863244a25.tex
@@ -1,7 +1,6 @@
 \hypertarget{dir_c85d3e3c5052e9ad9ce18c6863244a25}{}\section{src/lib Directory Reference}
 \label{dir_c85d3e3c5052e9ad9ce18c6863244a25}\index{src/lib Directory Reference@{src/lib Directory Reference}}
-Directory dependency graph for lib\+:
-\nopagebreak
+Directory dependency graph for lib\+:\nopagebreak
 \begin{figure}[H]
 \begin{center}
 \leavevmode

diff --git a/doc/latex/dir_fbd7474d75b2cb28dc50fdd7e41ac0c8.tex b/doc/latex/dir_fbd7474d75b2cb28dc50fdd7e41ac0c8.tex
@@ -1,7 +1,6 @@
 \hypertarget{dir_fbd7474d75b2cb28dc50fdd7e41ac0c8}{}\section{src/arduino/src Directory Reference}
 \label{dir_fbd7474d75b2cb28dc50fdd7e41ac0c8}\index{src/arduino/src Directory Reference@{src/arduino/src Directory Reference}}
-Directory dependency graph for src\+:
-\nopagebreak
+Directory dependency graph for src\+:\nopagebreak
 \begin{figure}[H]
 \begin{center}
 \leavevmode

diff --git a/doc/latex/refman.tex b/doc/latex/refman.tex
@@ -71,8 +71,8 @@
 \fancyhead[RO]{\fancyplain{}{\bfseries\thepage}}
 \fancyfoot[LE]{\fancyplain{}{}}
 \fancyfoot[CE]{\fancyplain{}{}}
-\fancyfoot[RE]{\fancyplain{}{\bfseries\scriptsize Generated on Tue Sep 13 2016 23\+:55\+:39 for Tiny protocol by Doxygen }}
-\fancyfoot[LO]{\fancyplain{}{\bfseries\scriptsize Generated on Tue Sep 13 2016 23\+:55\+:39 for Tiny protocol by Doxygen }}
+\fancyfoot[RE]{\fancyplain{}{\bfseries\scriptsize Generated on Wed Sep 14 2016 00\+:06\+:10 for Tiny protocol by Doxygen }}
+\fancyfoot[LO]{\fancyplain{}{\bfseries\scriptsize Generated on Wed Sep 14 2016 00\+:06\+:10 for Tiny protocol by Doxygen }}
 \fancyfoot[CO]{\fancyplain{}{}}
 \fancyfoot[RO]{\fancyplain{}{}}
 \renewcommand{\footrulewidth}{0.4pt}
@@ -128,7 +128,7 @@
 \vspace*{1cm}
 {\large Generated by Doxygen 1.8.9.1}\\
 \vspace*{0.5cm}
-{\small Tue Sep 13 2016 23:55:39}\\
+{\small Wed Sep 14 2016 00:06:10}\\
 \end{center}
 \end{titlepage}
 \clearemptydoublepage

diff --git a/doc/latex/tiny__layer2_8h.tex b/doc/latex/tiny__layer2_8h.tex
@@ -7,8 +7,7 @@
 
 {\ttfamily \#include $<$stdint.\+h$>$}\\*
 {\ttfamily \#include \char`\"{}tiny\+\_\+defines.\+h\char`\"{}}\\*
-Include dependency graph for tiny\+\_\+layer2.\+h\+:
-\nopagebreak
+Include dependency graph for tiny\+\_\+layer2.\+h\+:\nopagebreak
 \begin{figure}[H]
 \begin{center}
 \leavevmode

diff --git a/releases/arduino/TinyProtocol/library.properties b/releases/arduino/TinyProtocol/library.properties
@@ -1,5 +1,5 @@
 name=TinyProtocol
-version=0.3.2
+version=0.3.0
 author=Alexey Dynda
 maintainer=Alexey Dynda <[email protected]>
 sentence=Allows to communicate other boards/PC via any physical connection.

diff --git a/releases/arduino/TinyProtocol/src/proto/tiny_layer2.c b/releases/arduino/TinyProtocol/src/proto/tiny_layer2.c
@@ -141,17 +141,6 @@ inline static void  __commit_fcs_field(uint8_t fcs_bits, fcs_t* fcs)
 ***************************************************************/
 
 
-/**
-* The function initializes internal structures for Tiny channel and return handle
-* to be used with all Tiny and IPC functions.
-* @param handle - pointer to Tiny data
-* @param write_func - pointer to write data function (to communication channel).
-* @param read_func - pointer to read function (from communication channel).
-* @param pdata - pointer to a user private data.
-* @see write_block_cb_t
-* @see read_block_cb_t
-* @return TINY_NO_ERROR or error code.
-*/
 int tiny_init(STinyData *handle,
               write_block_cb_t write_func,
               read_block_cb_t read_func,
@@ -186,6 +175,7 @@ int tiny_init(STinyData *handle,
     return TINY_NO_ERROR;
 }
 
+//////////////////////////////////////////////////////////////////////////////
 
 int tiny_close(STinyData *handle)
 {
@@ -209,6 +199,7 @@ int tiny_close(STinyData *handle)
     return TINY_NO_ERROR;
 }
 
+///////////////////////////////////////////////////////////////////////////////
 
 int tiny_set_fcs_bits(STinyData *handle, uint8_t bits)
 {
@@ -820,13 +811,6 @@ int tiny_get_stat(STinyData *handle, STinyStats *stat)
 }
 
 
-/**
-* tiny_clear_stat function clears Tiny protocol statistics.
-* @param handle - pointer to Tiny protocol structure
-* @see TINY_ERR_INVALID_DATA
-* @see TINY_NO_ERROR
-* @return TINY_ERR_INVALID_DATA, TINY_NO_ERROR.
-*/
 int tiny_clear_stat(STinyData *handle)
 {
     if (handle)
@@ -841,14 +825,6 @@ int tiny_clear_stat(STinyData *handle)
 }
 
 
-/**
-* tiny_set_callbacks sets callback procs for specified Tiny protocol.
-* callbacks will receive all data being sent or received.
-* @param handle - pointer to Tiny Protocol structure
-* @param read_cb - an argument of on_frame_cb_t type - pointer to callback function.
-* @param send_cb - an argument of on_frame_cb_t type - pointer to callback function.
-* @return TINY_ERR_INVALID_DATA, TINY_NO_ERROR.
-*/
 int tiny_set_callbacks(STinyData *handle,
                on_frame_cb_t read_cb,
                on_frame_cb_t send_cb)

diff --git a/releases/arduino/TinyProtocol/src/proto/tiny_layer2.h b/releases/arduino/TinyProtocol/src/proto/tiny_layer2.h
@@ -285,6 +285,8 @@ extern int tiny_close(STinyData *handle);
 
 
 /**
+ * @brief sends frame to user payload to communication channel
+ *
  * The function sends data to communication channel in the following
  * frame format: 0x7E, data..., FCS, 0x7E.
  * \note if flags field is set to TINY_FLAG_NO_WAIT, then this function may remember pbuf