Improving documentation.

diff --git a/doc/reports/report/publish/tex/report1.pdf b/doc/reports/report/publish/tex/report1.pdf
deleted file mode 100644 (file)
index 5f36c57..0000000
Binary files a/doc/reports/report/publish/tex/report1.pdf and /dev/null differ

diff --git a/doc/reports/report/report.t2t b/doc/reports/report/report.t2t
index d48bf96b20708819c79d2d8d25d585035cd5e96e..9c65b885d5a447a61ad2cb14180e082e4385c9b9 100644 (file)
--- a/doc/reports/report/report.t2t
+++ b/doc/reports/report/report.t2t
@@ -9,6 +9,7 @@ Carlos Jenkins
 %!options(tex): --enum-title --toc --toc-level 5
 %!postproc(tex): '\.pdf\.png' '.pdf'
 %!postproc(tex): 'NEWPAGE' '\\newpage'
+%!postproc(tex): '-\$>\$' '\\noindent$\\rightarrow$'
 %!nested(tex): --docclass {article} --pdf
 
 %S = Table of contents =[table_of_contents]
@@ -482,6 +483,19 @@ How to wire the board for testing.
 The repository is hosted on the server of the Real-Time Systems group at the Department
 of Control Engineering
 
+```
+.
+|-- doc         - Documentation created for this project.
+|-- refs        - Official reference documentation.
+`-- rpp
+    |-- blocks  - Simulink RPP Block Library.
+    |-- demos   - Simulink RPP Demo Library.
+    |-- lib     - RPP Library and API.
+    `-- rpp     - Simulink RPP Target.
+```
+
+
+
 == Programming standards ==[programming_standards]
 
 
@@ -600,13 +614,119 @@ Compilation
 
 Anatomy
 
+
+NEWPAGE
+
 == Repository branch description ==[repository_branch_description]
 
+-> ``header.c`` and ``trailer.c``
+
+RPP framework for simple S-Functions.
+
+This files are included at the head and tail of each S-Function file. They include refactored and 
+commonly repeated structures that pollute S-Functions implementations. They include basic includes, 
+required definitions, macro definitions, common functions implementations and documentation on 
+optional functions and commented prototypes for optional model calls/hooks.
+
+- __Reference:__
+ - None.
+
+
+-> ``sfunction_{mnemonic}.c``
+
+C-MEX S-Function implementation for {mnemonic} block.
+
+This file implements the {mnemonic} block using C-MEX S-Function API. See the reference for information 
+about the S-Function API.
+
+- __Reference:__
+ - ``<repo>/refs/sfunctions.pdf``
+
+
+-> ``tlc_c/sfunction_{mnemonic}.tlc``
+
+Target Language Compiler (TLC) file for {mnemonic} block.
+
+This file implements the C code inlining for {mnemonic} block. See the reference for information about 
+the TLC API.
+
+- __Reference:__
+ - ``<repo>/refs/rtw_tlc.pdf``
+
+
+-> ``tlc_c/common.tlc``
+
+Common TLC functions.
+
+This file implements common TLC functions used by all the blocks.
+
+- __Reference:__
+ - None.
 
 
+-> ``slblocks.m``
+
+Simulink library control file.
+
+This file allows a group of blocks to be integrated into the Simulink Library and Simulink Library 
+Browser. This file is required by Simulink in order to interpret this folder as a block library. 
+For information about this file see the references.
+
+- __Reference:__
+ - ``<repo>/refs/rtw_ug.pdf`` p. 1127
+
+
+-> ``rpp_lib.slx``
+
+RPP Simulink block library.
+
+Simulink block library that includes all the blocks. This file is referenced by ``slblocks.m``
+
+- __Reference:__
+ - None.
+
+
+-> compile_blocks.m
+
+Blocks compilation script.
+
+This script compiles all the sfunction blocks to MEX executables. This script is called by the 
+``rpp_setup()`` function in order make all the blocks available to the Simulink environment or it 
+can be called independently when developing S-Functions.
+
+- __Reference:__
+ - None.
+
+
+NEWPAGE
+
 == Block Library Reference ==[block_library_reference]
 
+%tex% ''' \begin{figure}[H]\advance\leftskip-1cm
+[530-block_library.png]
+%tex% ''' \caption{Simulink RPP Block Library.}\end{figure}
+
+=== [LOUT] Digital Output block ===[lout_digital_output_block]
+
+
+
+=== [DIN] Digital Input block ===[din_digital_input_block]
+
+- Inputs : 0
+ - None
+- Outputs : 2
+ - ``bool``    Digital Input
+ - ``bool``    ErrFlag
+- Parameters : 2
+ - ``uint8``   Pin number [1-16]
+ - ``bool``    Use variable threshold
+
 
+Description.
+Implementation notes.
+On top of what was built.
+Relevant demos.
+Tested.
 
 = Simulink Demos =[simulink_demos]
 

diff --git a/rpp/blocks/README.txt b/rpp/blocks/README.txt
index ac0d2388b3b481ffdb7e765b8b4842f3edfcb25d..9e6799c3c35874e38ade486e76474668017fa7e0 100644 (file)
--- a/rpp/blocks/README.txt
+++ b/rpp/blocks/README.txt
@@ -75,6 +75,9 @@ Library file layout:
         documentation on optional functions and commented prototypes for
         optional model calls/hooks.
 
+        Reference:
+            None.
+
 
     -> sfunction_{mnemonic}.c