First step of inlining block documentation into S-Functions source

[pes-rpp/rpp-simulink.git] / doc / rpp_simulink.tex

diff --git a/doc/rpp_simulink.tex b/doc/rpp_simulink.tex
index eee26c56ccf78bf6535e6dd4222a13f2f66581db..3676c8a912e2d9ddd0914d1791c6a79d01b31c6d 100644 (file)
--- a/doc/rpp_simulink.tex
+++ b/doc/rpp_simulink.tex
@@ -2875,71 +2875,8 @@ block, which is not the most efficient but guaranties consistent behavior.
 \item \texttt{led\_blink}.
 \end{compactitem}
 
-\newpage
-
-\hypertarget{ain_analog_input_block}{}
-\subsubsection{ADC Analog Input block}
-
-\begin{verbatim}
-    Inputs      : 0
-        None
-
-    Outputs     : 2
-        uint16  Analog Input
-        bool    ErrFlag
-
-    Parameters  : 1
-        uint8   Pin number [1-12]
-\end{verbatim}
-
-This block allows to read the analog inputs on the RPP board. The ErrFlag should if raise 
-\texttt{rpp\_adc\_update()} or \texttt{rpp\_adc\_get()} returns error. \texttt{rpp\_adc\_update()} is called just by the 
-first DIN block in the model and thus only the first block could raise the flag because of this. 
-In case an error occurs the return value will always be 0. Because the ErrFlag should never set, 
-once set the following steps will never clear it back.
-
-\textbf{Status:}
-\begin{multicols}{3}
-
-\begin{compactitem}
-\item \textbf{Tested}:
- \begin{compactitem}
- \item Changing the pin.
- \item Compilation and general use.
- \end{compactitem}
-\end{compactitem}
-
-\vfill\columnbreak
-
-\begin{compactitem}
-\item \textbf{Untested}:
- \begin{compactitem}
- \item Faulty situation for the ErrFlag to set.
- \end{compactitem}
-\end{compactitem}
-
-\vfill\columnbreak
-
-\begin{compactitem}
-\item \textbf{Not working}:
-\end{compactitem}
-
-\end{multicols}
-
-\textbf{RPP API functions used:}
-
-\begin{compactitem}
-\item \texttt{rpp\_adc\_update()}.
-\item \texttt{rpp\_adc\_get()}.
-\end{compactitem}
-
-\textbf{Relevant demos:}
-
-\begin{compactitem}
-\item \texttt{analog\_passthrough}.
-\item \texttt{hbridge\_analog\_control}.
-\item \texttt{log\_analog\_input}.
-\end{compactitem}
+% Include automatically generated documentation
+\input{block_desc.tex}
 
 \newpage