]> rtime.felk.cvut.cz Git - jenkicar/rpp-simulink.git/commitdiff
Added block diagram to API main page.
authorCarlos Jenkins <carlos@jenkins.co.cr>
Thu, 13 Jun 2013 16:22:21 +0000 (18:22 +0200)
committerCarlos Jenkins <carlos@jenkins.co.cr>
Thu, 13 Jun 2013 16:22:21 +0000 (18:22 +0200)
rpp/lib/rpp/doc/api/content/blocks.png [new file with mode: 0644]
rpp/lib/rpp/doc/api/content/blocks_map.html [new file with mode: 0644]
rpp/lib/rpp/doc/api/content/cvut.png [moved from rpp/lib/rpp/doc/api/cvut.png with 100% similarity]
rpp/lib/rpp/doc/api/content/main_page.h [new file with mode: 0644]
rpp/lib/rpp/doc/api/doxygen.conf

diff --git a/rpp/lib/rpp/doc/api/content/blocks.png b/rpp/lib/rpp/doc/api/content/blocks.png
new file mode 100644 (file)
index 0000000..1cf82ff
Binary files /dev/null and b/rpp/lib/rpp/doc/api/content/blocks.png differ
diff --git a/rpp/lib/rpp/doc/api/content/blocks_map.html b/rpp/lib/rpp/doc/api/content/blocks_map.html
new file mode 100644 (file)
index 0000000..7548c7a
--- /dev/null
@@ -0,0 +1,17 @@
+<!-- You can edit me with kimagemapeditor -->
+<img usemap="#blocks_map" src="blocks.png">
+<map name="blocks_map">
+  <area shape="rect" alt="Digital Output" href="lout_8h.html" coords="125,5,247,96">
+  <area shape="rect" alt="Digital Input" href="din_8h.html" coords="125,122,247,213">
+  <area shape="rect" alt="Analog Output" href="aout_8h.html" coords="126,356,248,447">
+  <area shape="rect" alt="Analog Input" href="ain_8h.html" coords="125,239,247,330">
+  <area shape="rect" alt="Ethernet" href="eth_8h.html" coords="126,472,248,563">
+  <area shape="rect" alt="SD-Card" href="sdc_8h.html" coords="445,5,567,96">
+  <area shape="rect" alt="Power Output" href="mout_8h.html" coords="605,6,727,97">
+  <area shape="rect" alt="High-Power Output" href="hout_8h.html" coords="606,122,728,213">
+  <area shape="rect" alt="H-Bridge" href="hbr_8h.html" coords="606,239,728,330">
+  <area shape="rect" alt="LIN" href="lin_8h.html" coords="606,396,728,487">
+  <area shape="rect" alt="FlexRay" href="fr_8h.html" coords="606,513,728,604">
+  <area shape="rect" alt="CAN" href="can_8h.html" coords="606,628,728,719">
+  <area shape="rect" alt="SD-RAM" href="sdr_8h.html" coords="286,5,408,96">
+</map>
diff --git a/rpp/lib/rpp/doc/api/content/main_page.h b/rpp/lib/rpp/doc/api/content/main_page.h
new file mode 100644 (file)
index 0000000..67ee0ce
--- /dev/null
@@ -0,0 +1,15 @@
+/**
+ *
+ *\mainpage RPP Library API
+ *
+ * \section blocks Block diagram
+ *
+ * \htmlinclude blocks_map.html
+ *
+ * \section install_sec Installation
+ *
+ * \subsection step1 Step 1: Opening the box
+ *
+ *
+ *
+ */
index b0d0307a704714f9e3b20dab11936538a017c15e..98b7ebaf8d2cc704f17e0cfacd6272446e69aa0b 100644 (file)
@@ -45,7 +45,7 @@ PROJECT_BRIEF          =
 # exceed 55 pixels and the maximum width should not exceed 200 pixels.
 # Doxygen will copy the logo to the output directory.
 
-PROJECT_LOGO           = cvut.png
+PROJECT_LOGO           = ./content/cvut.png
 
 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
 # base path where the generated documentation will be put.
@@ -648,7 +648,7 @@ WARN_LOGFILE           =
 # directories like "/usr/src/myproject". Separate the files or directories
 # with spaces.
 
-INPUT                  = ../../include/ ../../include/rpp/
+INPUT                  = ../../include/ ../../include/rpp/ ./content/
 
 # This tag can be used to specify the character encoding of the source files
 # that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is
@@ -708,7 +708,7 @@ EXCLUDE_SYMBOLS        =
 # directories that contain example code fragments that are included (see
 # the \include command).
 
-EXAMPLE_PATH           =
+EXAMPLE_PATH           = ./content/
 
 # If the value of the EXAMPLE_PATH tag contains directories, you can use the
 # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
@@ -901,7 +901,7 @@ HTML_STYLESHEET        =
 # files. In the HTML_STYLESHEET file, use the file name only. Also note that
 # the files will be copied as-is; there are no commands or markers available.
 
-HTML_EXTRA_FILES       =
+HTML_EXTRA_FILES       = ./content/blocks.png
 
 # The HTML_COLORSTYLE_HUE tag controls the color of the HTML output.
 # Doxygen will adjust the colors in the style sheet and background images
@@ -1705,7 +1705,7 @@ DIRECTORY_GRAPH        = YES
 # HTML_FILE_EXTENSION to xhtml in order to make the SVG files
 # visible in IE 9+ (other browsers do not have this requirement).
 
-DOT_IMAGE_FORMAT       = png
+DOT_IMAGE_FORMAT       = svg
 
 # If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to
 # enable generation of interactive SVG images that allow zooming and panning.
@@ -1714,7 +1714,7 @@ DOT_IMAGE_FORMAT       = png
 # need to set HTML_FILE_EXTENSION to xhtml in order to make the SVG files
 # visible. Older versions of IE do not have SVG support.
 
-INTERACTIVE_SVG        = NO
+INTERACTIVE_SVG        = YES
 
 # The tag DOT_PATH can be used to specify the path where the dot tool can be
 # found. If left blank, it is assumed the dot tool can be found in the path.