From: Carlos Jenkins Date: Thu, 13 Jun 2013 16:22:21 +0000 (+0200) Subject: Added block diagram to API main page. X-Git-Tag: version_0.1~81 X-Git-Url: http://rtime.felk.cvut.cz/gitweb/jenkicar/rpp-simulink.git/commitdiff_plain/8d1d8031d0d6c0d7a5d3c07ce0f4db310c1b3a4d Added block diagram to API main page. --- diff --git a/rpp/lib/rpp/doc/api/content/blocks.png b/rpp/lib/rpp/doc/api/content/blocks.png new file mode 100644 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 index 0000000..7548c7a --- /dev/null +++ b/rpp/lib/rpp/doc/api/content/blocks_map.html @@ -0,0 +1,17 @@ + + + + Digital Output + Digital Input + Analog Output + Analog Input + Ethernet + SD-Card + Power Output + High-Power Output + H-Bridge + LIN + FlexRay + CAN + SD-RAM + diff --git a/rpp/lib/rpp/doc/api/cvut.png b/rpp/lib/rpp/doc/api/content/cvut.png similarity index 100% rename from rpp/lib/rpp/doc/api/cvut.png rename to rpp/lib/rpp/doc/api/content/cvut.png 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 index 0000000..67ee0ce --- /dev/null +++ b/rpp/lib/rpp/doc/api/content/main_page.h @@ -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 + * + * + * + */ diff --git a/rpp/lib/rpp/doc/api/doxygen.conf b/rpp/lib/rpp/doc/api/doxygen.conf index b0d0307..98b7eba 100644 --- a/rpp/lib/rpp/doc/api/doxygen.conf +++ b/rpp/lib/rpp/doc/api/doxygen.conf @@ -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.