]> rtime.felk.cvut.cz Git - pes-rpp/rpp-simulink.git/commitdiff
Continue improving documentation and a small documentation bug fixed.
authorCarlos Miguel Jenkins Pérez <carlos@jenkins.co.cr>
Mon, 17 Jun 2013 03:47:12 +0000 (05:47 +0200)
committerCarlos Miguel Jenkins Pérez <carlos@jenkins.co.cr>
Mon, 17 Jun 2013 03:47:12 +0000 (05:47 +0200)
doc/reports/report/report.t2t
rpp/lib/rpp/include/binary.h

index a362ac8014c354bf787d67ad5f8ccbc530c82f0f..3accd542f0700124c52ec6e7776ee7708e5131f4 100644 (file)
@@ -31,8 +31,12 @@ platform using Matlab/Simulink".
 The general layout of this document is as follows:
 
 - Project description, objectives and outcome. This section.
-- Software and Hardware setup for development and repository layout.
-- Extensive description for each of the four products delivered.
+- Software and Hardware setup for development, repository layout and programming standards.
+- A section for each of the four products delivered, with:
+ - Implementation fundamentals.
+ - Repository branch description.
+ - Product specific aspects.
+ - Reference documentation.
 - Glossary.
 - References.
 - Appendices.
@@ -301,14 +305,14 @@ Nested sources for this document can be found on the repository under ``<repo>/d
 %DONE
 
 The LMC1 is a simple script developed for this project written in Python 3 using Gtk+ 3.0 Python dynamic 
-bindings PyGObject. This script, based on Michal Horn command line only script, allows to set or clera the 
+bindings PyGObject. This script, based on Michal Horn command line only script, allows to set or clear the 
 outputs of the test board. 
 
 This script includes both a GUI and command line tool. If no parameters are given to the script the GUI 
 version is launched:
 
 %tex% ''' \begin{figure}[H]\begin{center}
-[400-lmc1.png]
+[350-lmc1.png]
 %tex% ''' \caption{LMC1 GUI application.}\end{center}\end{figure}
 
 To run the LMC1 application first install dependencies:
@@ -440,19 +444,20 @@ 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
 
-= Programming standards =[programming_standards]
+== Programming standards ==[programming_standards]
 
 
+NEWPAGE
 
-== TLC files ==[tlc_files]
+=== TLC files ===[tlc_files]
 
 
 
-== RPP API ==[rpp_api]
+=== RPP API ===[rpp_api]
 
 
 
-== S-Functions ==[s_functions]
+=== S-Functions ===[s_functions]
 
 
 
@@ -481,6 +486,8 @@ of Control Engineering
 RPP Target Options
 Simulink model options
 
+NEWPAGE
+
 = RPP Library and API =[rpp_library_and_api]
 
 
@@ -509,6 +516,10 @@ Talk about motivation, work done and compare against origin.
 - Prefix based functions names.
 - To be careful about symbol export.
 
+=== Pending refactoring tasks ===[pending_refactoring_tasks]
+
+
+
 == Repository branch description ==[repository_branch_description]
 
 
@@ -532,6 +543,7 @@ Talk about motivation, work done and compare against origin.
 == API Reference ==[api_reference]
 
 
+NEWPAGE
 
 = Simulink RPP Block Library =[simulink_rpp_block_library]
 
@@ -554,7 +566,7 @@ Anatomy
 
 
 
-== Block Reference ==[block_reference]
+== Block Library Reference ==[block_library_reference]
 
 
 
index 0912fb7eb6c1b6bb9dda32c46fbbfc611cd2c2c7..c8a58b0682bfd8b247393a0e485433b2437deda9 100644 (file)
@@ -18,7 +18,7 @@
 /**
  * Create a bit mask for given bit number.
  * For example:
- *  - _BV(7) -> B[0100 0000]
+ *  - _BV(7) -> B[1000 0000]
  *  - _BV(1) -> B[0000 0010]
  *  - _BV(0) -> B[0000 0001]
  *