alternative doxygen files for an output similar to rapidmixapi.com (previous...

alternative doxygen files for an output similar to rapidmixapi.com (previous backuped ad _rapidmix.doxyfile)

alternative doxygen files for an output similar to rapidmixapi.com (previous...
alternative doxygen files for an output similar to rapidmixapi.com (previous backuped ad _rapidmix.doxyfile)
596d70ed · Joseph Larralde · da976249 · 596d70ed · 596d70ed · 596d70ed
Commit 596d70ed authored 7 years ago by Joseph Larralde
--- a/docs/_rapidmix.doxyfile
+++ b/docs/_rapidmix.doxyfile
--- a/docs/fonts/Lato-Black.ttf
+++ b/docs/fonts/Lato-Black.ttf
--- a/docs/fonts/Lato-BlackItalic.ttf
+++ b/docs/fonts/Lato-BlackItalic.ttf
--- a/docs/fonts/Lato-Bold.ttf
+++ b/docs/fonts/Lato-Bold.ttf
--- a/docs/fonts/Lato-BoldItalic.ttf
+++ b/docs/fonts/Lato-BoldItalic.ttf
--- a/docs/fonts/Lato-Hairline.ttf
+++ b/docs/fonts/Lato-Hairline.ttf
--- a/docs/fonts/Lato-HairlineItalic.ttf
+++ b/docs/fonts/Lato-HairlineItalic.ttf
--- a/docs/fonts/Lato-Italic.ttf
+++ b/docs/fonts/Lato-Italic.ttf
--- a/docs/fonts/Lato-Light.ttf
+++ b/docs/fonts/Lato-Light.ttf
--- a/docs/fonts/Lato-LightItalic.ttf
+++ b/docs/fonts/Lato-LightItalic.ttf
--- a/docs/fonts/Lato-Regular.ttf
+++ b/docs/fonts/Lato-Regular.ttf
--- a/docs/rapidmix-footer.html
+++ b/docs/rapidmix-footer.html
+<!-- HTML footer for doxygen 1.8.14-->
+<!-- start footer part -->
+
+<!--BEGIN !GENERATE_TREEVIEW-->
+<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
+  <ul>
+    $navpath
+    <li class="footer">$generatedby
+    <a href="http://www.doxygen.org/index.html">
+    <img class="footer" src="$relpath^doxygen.png" alt="doxygen"/></a> $doxygenversion </li>
+  </ul>
+</div>
+<!--END !GENERATE_TREEVIEW-->
+<!--BEGIN GENERATE_TREEVIEW-->
+<hr class="footer"/><address class="footer"><small>
+$generatedby
+<!-- &#160; -->
+<a href="http://www.doxygen.org/index.html">
+<!-- <img class="footer" src="$relpath^doxygen.png" alt="doxygen"/> -->
+doxygen
+</a>
+$doxygenversion
+</small></address>
+<!--END GENERATE_TREEVIEW-->
+</body>
+</html>
--- a/docs/rapidmix-groups.doxygen
+++ b/docs/rapidmix-groups.doxygen
+/**
+ * @defgroup machinelearning Machine learning
+ */
+
+/**
+ * @defgroup signalprocessing Signal processing
+ * 
+ * @brief The Signal processing API is composed of :
+ * <ul>
+ * <li>
+ * a main header file : @ref signalProcessing.h
+ * </li>
+ * <li>
+ * a list of submodules based on PiPo and RapidStream
+ * </li>
+ * </ul>
+ */
--- a/docs/rapidmix-header.html
+++ b/docs/rapidmix-header.html
+<!-- HTML header for doxygen 1.8.14-->
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml">
+<head>
+<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
+<meta http-equiv="X-UA-Compatible" content="IE=9"/>
+<meta name="generator" content="Doxygen $doxygenversion"/>
+<meta name="viewport" content="width=device-width, initial-scale=1"/>
+
+<!--BEGIN PROJECT_NAME--><title>$projectname: $title</title><!--END PROJECT_NAME-->
+<!--BEGIN !PROJECT_NAME--><title>$title</title><!--END !PROJECT_NAME-->
+
+<script type="text/javascript" src="$relpath^jquery.js"></script>
+<script type="text/javascript" src="$relpath^dynsections.js"></script>
+
+<!-- $treeview -->
+<!-- $search -->
+<!-- $mathjax -->
+
+<link href="$relpath^$stylesheet" rel="stylesheet" type="text/css" />
+$extrastylesheet
+
+</head>
+<body>
+<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
+
+<!--BEGIN TITLEAREA-->
+<div id="titlearea">
+<table cellspacing="0" cellpadding="0">
+ <tbody>
+ <tr style="height: 56px;">
+
+  <!--BEGIN PROJECT_LOGO-->
+  <td id="projectlogo"><img alt="Logo" src="$relpath^$projectlogo"/></td>
+  <!--END PROJECT_LOGO-->
+
+
+  <!--BEGIN PROJECT_NAME-->
+  <td id="projectalign" style="padding-left: 0.5em;">
+   <div id="projectname">$projectname
+   <!--BEGIN PROJECT_NUMBER-->&#160;<span id="projectnumber">$projectnumber</span><!--END PROJECT_NUMBER-->
+   </div>
+   <!--BEGIN PROJECT_BRIEF--><div id="projectbrief">$projectbrief</div><!--END PROJECT_BRIEF-->
+  </td>
+  <!--END PROJECT_NAME-->
+
+
+  <!--BEGIN !PROJECT_NAME-->
+   <!--BEGIN PROJECT_BRIEF-->
+    <td style="padding-left: 0.5em;">
+    <div id="projectbrief">$projectbrief</div>
+    </td>
+   <!--END PROJECT_BRIEF-->
+  <!--END !PROJECT_NAME-->
+
+
+  <!--BEGIN DISABLE_INDEX-->
+   <!--BEGIN SEARCHENGINE-->
+   <td>$searchbox</td>
+   <!--END SEARCHENGINE-->
+  <!--END DISABLE_INDEX-->
+ </tr>
+ </tbody>
+</table>
+</div>
+
+
+<!--END TITLEAREA-->
+<!-- end header part -->
--- a/docs/rapidmix-layout.xml
+++ b/docs/rapidmix-layout.xml
+<doxygenlayout version="1.0">
+  <!-- Generated by doxygen 1.8.14 -->
+  <!-- Navigation index tabs for HTML output -->
+  <navindex>
+    <tab type="mainpage" visible="yes" title="Home"/>
+
+<!--     <tab type="pages" visible="no" title="" intro=""/>
+    <tab type="modules" visible="no" title="" intro=""/>
+    <tab type="namespaces" visible="no" title="">
+      <tab type="namespacelist" visible="yes" title="" intro=""/>
+      <tab type="namespacemembers" visible="yes" title="" intro=""/>
+    </tab>
+ -->    
+    <!-- http://www.matthewtyler.io/adding-tabs-in-doxygen/ -->
+    <tab type="user" url="@ref machinelearning" visible="yes" title="Machine learning"/>
+
+    <tab type="user" url="@ref signalprocessing" visible="yes" title="Signal processing"/>
+  
+    <!-- <tab type="classes" visible="yes" title="Classes"> -->
+      <tab type="classlist" visible="yes" title="Classes" intro=""/>
+<!--       <tab type="hierarchy" visible="yes" title="" intro=""/>
+      <tab type="classmembers" visible="yes" title="" intro=""/>
+    </tab>
+ --> 
+    <!-- <tab type="files" visible="yes" title="Files"> -->
+      <tab type="filelist" visible="yes" title="Files" intro=""/>
+<!--       <tab type="globals" visible="yes" title="" intro=""/>
+    </tab>
+ -->
+    <tab type="classindex" visible="yes" title="Reference" intro=""/>
+
+    <tab type="examples" visible="no" title="" intro=""/>  
+  </navindex>
+
+  <!-- Layout definition for a class page -->
+  <class>
+    <briefdescription visible="yes"/>
+    <includes visible="$SHOW_INCLUDE_FILES"/>
+    <inheritancegraph visible="$CLASS_GRAPH"/>
+    <collaborationgraph visible="$COLLABORATION_GRAPH"/>
+    <memberdecl>
+      <nestedclasses visible="yes" title=""/>
+      <publictypes title=""/>
+      <services title=""/>
+      <interfaces title=""/>
+      <publicslots title=""/>
+      <signals title=""/>
+      <publicmethods title=""/>
+      <publicstaticmethods title=""/>
+      <publicattributes title=""/>
+      <publicstaticattributes title=""/>
+      <protectedtypes title=""/>
+      <protectedslots title=""/>
+      <protectedmethods title=""/>
+      <protectedstaticmethods title=""/>
+      <protectedattributes title=""/>
+      <protectedstaticattributes title=""/>
+      <packagetypes title=""/>
+      <packagemethods title=""/>
+      <packagestaticmethods title=""/>
+      <packageattributes title=""/>
+      <packagestaticattributes title=""/>
+      <properties title=""/>
+      <events title=""/>
+      <privatetypes title=""/>
+      <privateslots title=""/>
+      <privatemethods title=""/>
+      <privatestaticmethods title=""/>
+      <privateattributes title=""/>
+      <privatestaticattributes title=""/>
+      <friends title=""/>
+      <related title="" subtitle=""/>
+      <membergroups visible="yes"/>
+    </memberdecl>
+    <detaileddescription title=""/>
+    <memberdef>
+      <inlineclasses title=""/>
+      <typedefs title=""/>
+      <enums title=""/>
+      <services title=""/>
+      <interfaces title=""/>
+      <constructors title=""/>
+      <functions title=""/>
+      <related title=""/>
+      <variables title=""/>
+      <properties title=""/>
+      <events title=""/>
+    </memberdef>
+    <allmemberslink visible="yes"/>
+    <usedfiles visible="$SHOW_USED_FILES"/>
+    <authorsection visible="yes"/>
+  </class>
+
+  <!-- Layout definition for a namespace page -->
+  <namespace>
+    <briefdescription visible="yes"/>
+    <memberdecl>
+      <nestednamespaces visible="yes" title=""/>
+      <constantgroups visible="yes" title=""/>
+      <classes visible="yes" title=""/>
+      <typedefs title=""/>
+      <enums title=""/>
+      <functions title=""/>
+      <variables title=""/>
+      <membergroups visible="yes"/>
+    </memberdecl>
+    <detaileddescription title=""/>
+    <memberdef>
+      <inlineclasses title=""/>
+      <typedefs title=""/>
+      <enums title=""/>
+      <functions title=""/>
+      <variables title=""/>
+    </memberdef>
+    <authorsection visible="yes"/>
+  </namespace>
+
+  <!-- Layout definition for a file page -->
+  <file>
+    <briefdescription visible="yes"/>
+    <includes visible="$SHOW_INCLUDE_FILES"/>
+    <includegraph visible="$INCLUDE_GRAPH"/>
+    <includedbygraph visible="$INCLUDED_BY_GRAPH"/>
+    <sourcelink visible="yes"/>
+    <memberdecl>
+      <classes visible="yes" title=""/>
+      <namespaces visible="yes" title=""/>
+      <constantgroups visible="yes" title=""/>
+      <defines title=""/>
+      <typedefs title=""/>
+      <enums title=""/>
+      <functions title=""/>
+      <variables title=""/>
+      <membergroups visible="yes"/>
+    </memberdecl>
+    <detaileddescription title=""/>
+    <memberdef>
+      <inlineclasses title=""/>
+      <defines title=""/>
+      <typedefs title=""/>
+      <enums title=""/>
+      <functions title=""/>
+      <variables title=""/>
+    </memberdef>
+    <authorsection/>
+  </file>
+
+  <!-- Layout definition for a group page -->
+  <group>
+    <detaileddescription title=""/>
+    <!-- <briefdescription visible="no"/> -->
+    <!-- <groupgraph visible="$GROUP_GRAPHS"/> -->
+    <memberdecl>
+      <nestedgroups visible="yes" title=""/>
+      <dirs visible="yes" title=""/>
+      <files visible="yes" title=""/>
+      <namespaces visible="yes" title=""/>
+      <classes visible="yes" title=""/>
+      <defines title=""/>
+      <typedefs title=""/>
+      <enums title=""/>
+      <enumvalues title=""/>
+      <functions title=""/>
+      <variables title=""/>
+      <signals title=""/>
+      <publicslots title=""/>
+      <protectedslots title=""/>
+      <privateslots title=""/>
+      <events title=""/>
+      <properties title=""/>
+      <friends title=""/>
+      <membergroups visible="yes"/>
+    </memberdecl>
+    <memberdef>
+      <pagedocs/>
+      <inlineclasses title=""/>
+      <defines title=""/>
+      <typedefs title=""/>
+      <enums title=""/>
+      <enumvalues title=""/>
+      <functions title=""/>
+      <variables title=""/>
+      <signals title=""/>
+      <publicslots title=""/>
+      <protectedslots title=""/>
+      <privateslots title=""/>
+      <events title=""/>
+      <properties title=""/>
+      <friends title=""/>
+    </memberdef>
+    <authorsection visible="yes"/>
+  </group>
+
+  <!-- Layout definition for a directory page -->
+  <directory>
+    <briefdescription visible="yes"/>
+    <directorygraph visible="yes"/>
+    <memberdecl>
+      <dirs visible="yes"/>
+      <files visible="yes"/>
+    </memberdecl>
+    <detaileddescription title=""/>
+  </directory>
+</doxygenlayout>
--- a/docs/rapidmix-scripts.js
+++ b/docs/rapidmix-scripts.js
+window.onload = function() {
+  var contents = document.querySelector('#doc-content');
+  // console.log(contents);
+};
\ No newline at end of file
--- a/docs/rapidmix-search.css
+++ b/docs/rapidmix-search.css
+/*---------------- Search Box */
+
+#FSearchBox {
+    float: left;
+}
+
+#MSearchBox {
+    white-space : nowrap;
+    float: none;
+    /*margin-top: 8px;*/
+    margin-top: 7px;
+    right: 0px;
+    width: 170px;
+    height: 24px;
+    z-index: 102;
+    border: 1px #333 solid;
+    border-radius: 12px;
+}
+
+#MSearchBox .left
+{
+    display:block;
+    /*display: none;*/
+    position:absolute;
+    /*left:10px;*/
+    /*width:20px;*/
+    left: 0px;
+    width: 0px;
+    height:19px;
+    /*background:url('search_l.png') no-repeat;*/
+    background:none;
+    background-position:right;
+}
+
+#MSearchSelect {
+    /*display:block;*/
+    display:none;
+    position:absolute;
+    /*width:20px;*/
+    height:19px;
+}
+
+.left #MSearchSelect {
+    left:4px;
+}
+
+.right #MSearchSelect {
+    right:5px;
+}
+
+#MSearchField {
+    display:block;
+    position:absolute;
+    height:19px;
+    /*background:url('search_m.png') repeat-x;*/
+    background:none;
+    border:none;
+
+    /*width:115px;*/
+    width:140px;
+    
+    /*margin-left:20px;*/
+    margin-left:0px;
+
+    /*padding-left:4px;*/
+    padding-left: 10px;
+
+    /*color: #909090;*/
+    color: #aaa;
+
+    outline: none;
+    font: 9pt Arial, Verdana, sans-serif;
+    -webkit-border-radius: 0px;
+}
+
+#FSearchBox #MSearchField {
+    margin-left:15px;
+}
+
+#MSearchBox .right {
+    display:block;
+    position:absolute;
+    right:10px;
+    top:8px;
+    width:20px;
+    height:19px;
+    /*background:url('search_r.png') no-repeat;*/
+    background:none;
+    background-position:left;
+}
+
+#MSearchClose {
+    display: none;
+    position: absolute;
+    top: 4px;
+    background : none;
+    border: none;
+    margin: 0px 4px 0px 0px;
+    padding: 0px 0px;
+    outline: none;
+}
+
+.left #MSearchClose {
+    left: 6px;
+}
+
+.right #MSearchClose {
+    right: 2px;
+}
+
+#MSearchCloseImg {
+    content:unset;
+}
+
+#MSearchCloseImg:before {
+    position:absolute;
+    content:'X';
+}
+
+.MSearchBoxActive #MSearchField {
+    /*color: #000000;*/
+    color: #fff;
+}
+
+/*---------------- Search filter selection */
+
+#MSearchSelectWindow {
+    display: none;
+    position: absolute;
+    left: 0; top: 0;
+    border: 1px solid #90A5CE;
+    background-color: #F9FAFC;
+    z-index: 10001;
+    padding-top: 4px;
+    padding-bottom: 4px;
+    
+    -moz-border-radius: 4px;
+    -webkit-border-top-left-radius: 4px;
+    -webkit-border-top-right-radius: 4px;
+    -webkit-border-bottom-left-radius: 4px;
+    -webkit-border-bottom-right-radius: 4px;
+    
+    -webkit-box-shadow: 5px 5px 5px rgba(0, 0, 0, 0.15);
+}
+
+.SelectItem {
+    font: 8pt Arial, Verdana, sans-serif;
+    padding-left:  2px;
+    padding-right: 12px;
+    border: 0px;
+}
+
+span.SelectionMark {
+    margin-right: 4px;
+    font-family: monospace;
+    outline-style: none;
+    text-decoration: none;
+}
+
+a.SelectItem {
+    display: block;
+    outline-style: none;
+    color: #000000; 
+    text-decoration: none;
+    padding-left:   6px;
+    padding-right: 12px;
+}
+
+a.SelectItem:focus,
+a.SelectItem:active {
+    color: #000000; 
+    outline-style: none;
+    text-decoration: none;
+}
+
+a.SelectItem:hover {
+    color: #FFFFFF;
+    background-color: #3D578C;
+    outline-style: none;
+    text-decoration: none;
+    cursor: pointer;
+    display: block;
+}
+
+/*---------------- Search results window */
+
+iframe#MSearchResults {
+    width: 60ex;
+    height: 15em;
+}
+
+#MSearchResultsWindow {
+    display: none;
+    position: absolute;
+    left: 0; top: 0;
+    border: 1px solid #000;
+    background-color: #EEF1F7;
+    z-index:10000;
+}
+
+/* ----------------------------------- */
+
+
+#SRIndex {
+    clear:both; 
+    padding-bottom: 15px;
+}
+
+.SREntry {
+    font-size: 10pt;
+    padding-left: 1ex;
+}
+
+.SRPage .SREntry {
+    font-size: 8pt;
+    padding: 1px 5px;
+}
+
+body.SRPage {
+    margin: 5px 2px;
+}
+
+.SRChildren {
+    padding-left: 3ex; padding-bottom: .5em 
+}
+
+.SRPage .SRChildren {
+    display: none;
+}
+
+.SRSymbol {
+    font-weight: bold; 
+    color: #425E97;
+    font-family: Arial, Verdana, sans-serif;
+    text-decoration: none;
+    outline: none;
+}
+
+a.SRScope {
+    display: block;
+    color: #425E97; 
+    font-family: Arial, Verdana, sans-serif;
+    text-decoration: none;
+    outline: none;
+}
+
+a.SRSymbol:focus, a.SRSymbol:active,
+a.SRScope:focus, a.SRScope:active {
+    text-decoration: underline;
+}
+
+span.SRScope {
+    padding-left: 4px;
+}
+
+.SRPage .SRStatus {
+    padding: 2px 5px;
+    font-size: 8pt;
+    font-style: italic;
+}
+
+.SRResult {
+    display: none;
+}
+
+DIV.searchresults {
+    margin-left: 10px;
+    margin-right: 10px;
+}
+
+/*---------------- External search page results */
+
+.searchresult {
+    background-color: #F0F3F8;
+}
+
+.pages b {
+   color: white;
+   padding: 5px 5px 3px 5px;
+   /*background-image: url("../tab_a.png");*/
+   background-image: none;
+   background-repeat: repeat-x;
+   text-shadow: 0 1px 1px #000000;
+}
+
+.pages {
+    line-height: 17px;
+    margin-left: 4px;
+    text-decoration: none;
+}
+
+.hl {
+    font-weight: bold;
+}
+
+#searchresults {
+    margin-bottom: 20px;
+}
+
+.searchpages {
+    margin-top: 10px;
+}
+
--- a/docs/rapidmix-style.css
+++ b/docs/rapidmix-style.css
--- a/docs/rapidmix-tabs.css
+++ b/docs/rapidmix-tabs.css
--- a/docs/rapidmix.doxyfile
+++ b/docs/rapidmix.doxyfile