├── LICENSE
├── README.md
├── doxy-boot.js
├── footer.html
├── header.html
├── layout.xml
└── style.css


/LICENSE:
--------------------------------------------------------------------------------
 1 | Copyright (c) 2016, Stratify Labs
 2 | All rights reserved.
 3 | 
 4 | Redistribution and use in source and binary forms, with or without
 5 | modification, are permitted provided that the following conditions are met:
 6 | 
 7 | * Redistributions of source code must retain the above copyright notice, this
 8 |   list of conditions and the following disclaimer.
 9 | 
10 | * Redistributions in binary form must reproduce the above copyright notice,
11 |   this list of conditions and the following disclaimer in the documentation
12 |   and/or other materials provided with the distribution.
13 | 
14 | * Neither the name of Doxygen-Bootstrap nor the names of its
15 |   contributors may be used to endorse or promote products derived from
16 |   this software without specific prior written permission.
17 | 
18 | THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
19 | AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20 | IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
21 | DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
22 | FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
23 | DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
24 | SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
25 | CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
26 | OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
27 | OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28 | 


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | # Doxygen-Bootstrap
2 | This is a small project for integrating Doxygen output with Twitter Bootstrap.
3 | 
4 | See the Stratify Documentation for an example:  https://stratifylabs.co/StratifyAPI/html/
5 | 
6 | The header.html and footer.html files in this repo are designed to be used with Jekyll and Github pages (specifically it is based on https://github.com/plusjade/jekyll-bootstrap/).  Be sure to modify the header/footer html files so that they fit your needs.  You can look at the source of https://stratifylabs.co/StratifyAPI/html/ to see what css and js files are used in the header.
7 | 


--------------------------------------------------------------------------------
/doxy-boot.js:
--------------------------------------------------------------------------------
 1 | /*
 2 | 
 3 | Copyright (c) 2013-2016, Tyler Gilbert
 4 | All rights reserved.
 5 | 
 6 | Redistribution and use in source and binary forms, with or without
 7 | modification, are permitted provided that the following conditions are met:
 8 |     * Redistributions of source code must retain the above copyright
 9 |       notice, this list of conditions and the following disclaimer.
10 |     * Redistributions in binary form must reproduce the above copyright
11 |       notice, this list of conditions and the following disclaimer in the
12 |       documentation and/or other materials provided with the distribution.
13 |     * Neither the name of the <organization> nor the
14 |       names of its contributors may be used to endorse or promote products
15 |       derived from this software without specific prior written permission.
16 | 
17 | THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
18 | ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
19 | WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
20 | DISCLAIMED. IN NO EVENT SHALL <COPYRIGHT HOLDER> BE LIABLE FOR ANY
21 | DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
22 | (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
23 | LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
24 | ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25 | (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
26 | SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27 | */
28 | 
29 | $( document ).ready(function() {
30 | 
31 | 	$("div.headertitle").addClass("page-header");
32 | 	$("div.title").addClass("h1");
33 | 	
34 | 	$('li > a[href="index.html"] > span').before("<i class='fa fa-cog'></i> ");
35 | 	$('li > a[href="index.html"] > span').text("Stratify Labs");
36 | 	$('li > a[href="modules.html"] > span').before("<i class='fa fa-square'></i> ");
37 | 	$('li > a[href="namespaces.html"] > span').before("<i class='fa fa-bars'></i> ");
38 | 	$('li > a[href="annotated.html"] > span').before("<i class='fa fa-list-ul'></i> ");
39 | 	$('li > a[href="classes.html"] > span').before("<i class='fa fa-book'></i> ");
40 | 	$('li > a[href="inherits.html"] > span').before("<i class='fa fa-sitemap'></i> ");
41 | 	$('li > a[href="functions.html"] > span').before("<i class='fa fa-list'></i> ");
42 | 	$('li > a[href="functions_func.html"] > span').before("<i class='fa fa-list'></i> ");
43 | 	$('li > a[href="functions_vars.html"] > span').before("<i class='fa fa-list'></i> ");
44 | 	$('li > a[href="functions_enum.html"] > span').before("<i class='fa fa-list'></i> ");
45 | 	$('li > a[href="functions_eval.html"] > span').before("<i class='fa fa-list'></i> ");
46 | 	$(".icona .icon").addClass("label label-danger");
47 | 	$(".icona .icon").after(" ");
48 | 
49 | 	$('img[src="closed.png"]').before("<i class='fa fa-chevron-right'></i> ");
50 | 	$('img[src="closed.png"]').hide();
51 | 
52 | 	$("div.qindex").css("margin-bottom", "3em");
53 | 	$("div.textblock").css("margin-bottom", "3em");
54 | 	$("table.memberdecls").css("margin-bottom", "3em");
55 | 	$("table.memberdecls").css("margin-top", "3em");
56 | 
57 | 
58 | 	$("span.arrow").replaceWith("<i class='fa fa-chevron-right'></i> ");
59 | 
60 | 	$("ul.tablist").addClass("nav nav-pills");
61 | 	$("ul.tablist").css("margin-top", "0.5em");
62 | 	$("ul.tablist").css("margin-bottom", "0.5em");
63 | 	$("li.current").addClass("active");
64 | 	$("iframe").attr("scrolling", "yes");
65 | 	
66 | 	$("#nav-path > ul").addClass("breadcrumb");
67 | 	
68 | 	$("table.params").addClass("table");
69 | 	$("div.ingroups").wrapInner("<small></small>");
70 | 	$("div.levels").css("margin", "0.5em");
71 | 	$("div.levels > span").addClass("btn btn-default btn-xs");
72 | 	$("div.levels > span").css("margin-right", "0.25em");
73 | 	
74 | 	$("table.directory").addClass("table table-striped table-bordered");
75 | 	$("[class^=separator]").remove();
76 | 
77 | 	$("div.summary > a").addClass("btn btn-default btn-xs");
78 | 	$("table.fieldtable").addClass("table");
79 | 	$(".fragment").addClass("well");
80 | 	$(".memitem").addClass("panel panel-default");
81 | 	$(".memproto").addClass("panel-heading");
82 | 	$(".memdoc").addClass("panel-body");
83 | 	$("span.mlabel").addClass("label label-info");
84 | 	
85 | 	$("table.memberdecls").addClass("table table-bordered");
86 | 	//$("[class^=memitem]").addClass("active");
87 | 	
88 | 	$("div.ah").addClass("btn btn-default");
89 | 	$("span.mlabels").addClass("pull-right");
90 | 	$("table.mlabels").css("width", "100%")
91 | 	$("td.mlabels-right").addClass("pull-right");
92 | 
93 | 	$("div.ttc").addClass("panel panel-info");
94 | 	$("div.ttname").addClass("panel-heading");
95 | 	$("div.ttdef,div.ttdoc,div.ttdeci").addClass("panel-body");
96 | 	
97 | 	
98 | });


--------------------------------------------------------------------------------
/footer.html:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/StratifyLabs/Doxygen-Bootstrap/31df6fe68a6063199c95ba9bffda2af3846ad37e/footer.html


--------------------------------------------------------------------------------
/header.html:
--------------------------------------------------------------------------------
 1 | ---
 2 | layout: page
 3 | title: Stratify OS Docs
 4 | ---
 5 | 
 6 | {% include JB/setup %}
 7 | 
 8 | <script type="text/javascript" src="doxy-boot.js"></script>
 9 | <script type="text/javascript" src="dynsections.js"></script>
10 | <link href="style.css" rel="stylesheet" type="text/css" />
11 | 
12 | 


--------------------------------------------------------------------------------
/layout.xml:
--------------------------------------------------------------------------------
  1 | <doxygenlayout version="1.0">
  2 |   <!-- Navigation index tabs for HTML output -->
  3 |   <navindex>
  4 |     <tab type="mainpage" visible="yes" title=""/>
  5 |     <tab type="pages" visible="no" title="" intro=""/>
  6 |     <tab type="modules" visible="yes" title="" intro=""/>
  7 |     <tab type="namespaces" visible="yes" title="">
  8 |     <tab type="namespaces" visible="yes" title="" intro=""/>
  9 |     <tab type="namespacemembers" visible="yes" title="" intro=""/>
 10 |     </tab>
 11 |     <tab type="classes" visible="yes" title="">
 12 |       <tab type="classlist" visible="yes" title="" intro=""/>
 13 |       <tab type="classindex" visible="$ALPHABETICAL_INDEX" title=""/> 
 14 |     </tab>
 15 |     <tab type="files" visible="no" title="">
 16 |       <tab type="filelist" visible="no" title="" intro=""/>
 17 |       <tab type="globals" visible="no" title="" intro=""/>
 18 |     </tab>
 19 |     <tab type="examples" visible="no" title="" intro=""/>  
 20 |   </navindex>
 21 | 
 22 |   <!-- Layout definition for a class page -->
 23 |   <class>
 24 |     <briefdescription visible="no"/>
 25 |     <inheritancegraph visible="$CLASS_GRAPH"/>
 26 |     <collaborationgraph visible="$COLLABORATION_GRAPH"/>
 27 |     <allmemberslink visible="yes"/>
 28 |     <detaileddescription title="Documentation"/>
 29 |     <memberdecl>
 30 |       <nestedclasses visible="yes" title=""/>
 31 |       <publictypes title=""/>
 32 |       <publicslots title=""/>
 33 |       <signals title=""/>
 34 |       <publicmethods title=""/>
 35 |       <publicstaticmethods title=""/>
 36 |       <publicattributes title=""/>
 37 |       <publicstaticattributes title=""/>
 38 |       <protectedtypes title=""/>
 39 |       <protectedslots title=""/>
 40 |       <protectedmethods title=""/>
 41 |       <protectedstaticmethods title=""/>
 42 |       <protectedattributes title=""/>
 43 |       <protectedstaticattributes title=""/>
 44 |       <packagetypes title=""/>
 45 |       <packagemethods title=""/>
 46 |       <packagestaticmethods title=""/>
 47 |       <packageattributes title=""/>
 48 |       <packagestaticattributes title=""/>
 49 |       <properties title=""/>
 50 |       <events title=""/>
 51 |       <privatetypes title=""/>
 52 |       <privateslots title=""/>
 53 |       <privatemethods title=""/>
 54 |       <privatestaticmethods title=""/>
 55 |       <privateattributes title=""/>
 56 |       <privatestaticattributes title=""/>
 57 |       <friends title=""/>
 58 |       <related title="" subtitle=""/>
 59 |       <membergroups visible="yes"/>
 60 |     </memberdecl>
 61 |     <memberdef>
 62 |       <inlineclasses title=""/>
 63 |       <typedefs title=""/>
 64 |       <enums title=""/>
 65 |       <constructors title=""/>
 66 |       <functions title=""/>
 67 |       <related title=""/>
 68 |       <variables title=""/>
 69 |       <properties title=""/>
 70 |       <events title=""/>
 71 |     </memberdef>
 72 |     <usedfiles visible="$SHOW_USED_FILES"/>
 73 |     <authorsection visible="yes"/>
 74 |   </class>
 75 | 
 76 |   <!-- Layout definition for a namespace page -->
 77 |   <namespace>
 78 |     <briefdescription visible="yes"/>
 79 |     <memberdecl>
 80 |       <nestednamespaces visible="yes" title=""/>
 81 |       <classes visible="yes" title=""/>
 82 |       <typedefs title=""/>
 83 |       <enums title=""/>
 84 |       <functions title=""/>
 85 |       <variables title=""/>
 86 |       <membergroups visible="yes"/>
 87 |     </memberdecl>
 88 |     <memberdef>
 89 |       <inlineclasses title=""/>
 90 |       <typedefs title=""/>
 91 |       <enums title=""/>
 92 |       <functions title=""/>
 93 |       <variables title=""/>
 94 |     </memberdef>
 95 |     <authorsection visible="yes"/>
 96 |   </namespace>
 97 | 
 98 |   <!-- Layout definition for a file page -->
 99 |   <file>
100 |     <briefdescription visible="yes"/>
101 |     <includes visible="$SHOW_INCLUDE_FILES"/>
102 |     <includegraph visible="$INCLUDE_GRAPH"/>
103 |     <includedbygraph visible="$INCLUDED_BY_GRAPH"/>
104 |     <sourcelink visible="no"/>
105 |     <memberdecl>
106 |       <classes visible="yes" title=""/>
107 |       <namespaces visible="yes" title=""/>
108 |       <defines title=""/>
109 |       <typedefs title=""/>
110 |       <enums title=""/>
111 |       <functions title=""/>
112 |       <variables title=""/>
113 |       <membergroups visible="yes"/>
114 |     </memberdecl>
115 |     <detaileddescription title="Documentation"/>
116 |     <memberdef>
117 |       <inlineclasses title=""/>
118 |       <defines title=""/>
119 |       <typedefs title=""/>
120 |       <enums title=""/>
121 |       <functions title=""/>
122 |       <variables title=""/>
123 |     </memberdef>
124 |     <authorsection/>
125 |   </file>
126 | 
127 |   <!-- Layout definition for a group page -->
128 |   <group>
129 |     <groupgraph visible="$GROUP_GRAPHS"/>
130 |     <briefdescription visible="yes"/>
131 |   	<detaileddescription title="Documentation"/>
132 |     <memberdecl>
133 |       <classes visible="yes" title=""/>
134 |       <namespaces visible="yes" title=""/>
135 |       <dirs visible="yes" title=""/>
136 |       <nestedgroups visible="yes" title=""/>
137 |       <defines title=""/>
138 |       <typedefs title=""/>
139 |       <enums title=""/>
140 |       <enumvalues title=""/>
141 |       <functions title=""/>
142 |       <variables title=""/>
143 |       <signals title=""/>
144 |       <publicslots title=""/>
145 |       <protectedslots title=""/>
146 |       <privateslots title=""/>
147 |       <events title=""/>
148 |       <properties title=""/>
149 |       <friends title=""/>
150 |       <membergroups visible="yes"/>
151 |     </memberdecl>
152 |     
153 |     <memberdef>
154 |       <pagedocs/>
155 |       <inlineclasses title=""/>
156 |       <defines title=""/>
157 |       <typedefs title=""/>
158 |       <enums title=""/>
159 |       <enumvalues title=""/>
160 |       <functions title=""/>
161 |       <variables title=""/>
162 |       <signals title=""/>
163 |       <publicslots title=""/>
164 |       <protectedslots title=""/>
165 |       <privateslots title=""/>
166 |       <events title=""/>
167 |       <properties title=""/>
168 |       <friends title=""/>
169 |     </memberdef>
170 |     <authorsection visible="yes"/>
171 |   </group>
172 | 
173 |   <!-- Layout definition for a directory page -->
174 |   <directory>
175 |     <briefdescription visible="yes"/>
176 |     <directorygraph visible="yes"/>
177 |     <memberdecl>
178 |       <dirs visible="yes"/>
179 |       <files visible="yes"/>
180 |     </memberdecl>
181 |     <detaileddescription title="Documentation"/>
182 |   </directory>
183 | </doxygenlayout>
184 | 


--------------------------------------------------------------------------------
/style.css:
--------------------------------------------------------------------------------
  1 | /* The standard CSS for doxygen */
  2 | 
  3 | pre.fragment {
  4 |         padding: 4px 6px;
  5 |         margin: 4px 8px 4px 2px;
  6 |         overflow: auto;
  7 |         word-wrap: break-word;
  8 |         font-size:  12pt;
  9 |         line-height: 125%;
 10 |         font-family: monospace, fixed;
 11 |         font-size: 110%;
 12 | }
 13 | 
 14 | div.fragment {
 15 |         padding: 4px;
 16 |         margin: 4px;
 17 | }
 18 | 
 19 | div.line {
 20 | 	font-family: monospace, fixed;
 21 |         font-size: 16px;
 22 | 	min-height: 13px;
 23 | 	line-height: 1.0;
 24 | 	text-wrap: unrestricted;
 25 | 	white-space: -moz-pre-wrap; /* Moz */
 26 | 	white-space: -pre-wrap;     /* Opera 4-6 */
 27 | 	white-space: -o-pre-wrap;   /* Opera 7 */
 28 | 	white-space: pre-wrap;      /* CSS3  */
 29 | 	word-wrap: break-word;      /* IE 5.5+ */
 30 | 	text-indent: -53px;
 31 | 	padding-left: 53px;
 32 | 	padding-bottom: 0px;
 33 | 	margin: 0px;
 34 | 	-webkit-transition-property: background-color, box-shadow;
 35 | 	-webkit-transition-duration: 0.5s;
 36 | 	-moz-transition-property: background-color, box-shadow;
 37 | 	-moz-transition-duration: 0.5s;
 38 | 	-ms-transition-property: background-color, box-shadow;
 39 | 	-ms-transition-duration: 0.5s;
 40 | 	-o-transition-property: background-color, box-shadow;
 41 | 	-o-transition-duration: 0.5s;
 42 | 	transition-property: background-color, box-shadow;
 43 | 	transition-duration: 0.5s;
 44 | }
 45 | 
 46 | div.line.glow {
 47 | 	background-color: cyan;
 48 | 	box-shadow: 0 0 10px cyan;
 49 | }
 50 | 
 51 | 
 52 | span.lineno {
 53 | 	padding-right: 4px;
 54 | 	text-align: right;
 55 | 	border-right: 2px solid #0F0;
 56 |         white-space: pre;
 57 | }
 58 | 
 59 | div.groupHeader {
 60 | 	margin-left: 16px;
 61 | 	margin-top: 12px;
 62 | 	font-weight: bold;
 63 | }
 64 | 
 65 | div.groupText {
 66 | 	margin-left: 16px;
 67 | 	font-style: italic;
 68 | }
 69 | 
 70 | 
 71 | td.indexkey {
 72 | 	background-color: #EBEFF6;
 73 | 	font-weight: bold;
 74 | 	border: 1px solid #C4CFE5;
 75 | 	margin: 2px 0px 2px 0;
 76 | 	padding: 2px 10px;
 77 |         white-space: nowrap;
 78 |         vertical-align: top;
 79 | }
 80 | 
 81 | td.indexvalue {
 82 | 	background-color: #EBEFF6;
 83 | 	border: 1px solid #C4CFE5;
 84 | 	padding: 2px 10px;
 85 | 	margin: 2px 0px;
 86 | }
 87 | 
 88 | tr.memlist {
 89 | 	background-color: #EEF1F7;
 90 | }
 91 | 
 92 | p.formulaDsp {
 93 | 	text-align: center;
 94 | }
 95 | 
 96 | img.formulaDsp {
 97 | 	
 98 | }
 99 | 
100 | img.formulaInl {
101 | 	vertical-align: middle;
102 | }
103 | 
104 | div.center {
105 | 	text-align: center;
106 |         margin-top: 0px;
107 |         margin-bottom: 0px;
108 |         padding: 0px;
109 | }
110 | 
111 | div.center img {
112 | 	border: 0px;
113 | }
114 | 
115 | address.footer {
116 | 	text-align: right;
117 | 	padding-right: 12px;
118 | }
119 | 
120 | img.footer {
121 | 	border: 0px;
122 | 	vertical-align: middle;
123 | }
124 | 
125 | /* @group Code Colorization */
126 | 
127 | span.keyword {
128 | 	color: #008000
129 | }
130 | 
131 | span.keywordtype {
132 | 	color: #604020
133 | }
134 | 
135 | span.keywordflow {
136 | 	color: #e08000
137 | }
138 | 
139 | span.comment {
140 | 	color: #800000
141 | }
142 | 
143 | span.preprocessor {
144 | 	color: #806020
145 | }
146 | 
147 | span.stringliteral {
148 | 	color: #002080
149 | }
150 | 
151 | span.charliteral {
152 | 	color: #008080
153 | }
154 | 
155 | span.vhdldigit { 
156 | 	color: #ff00ff 
157 | }
158 | 
159 | span.vhdlchar { 
160 | 	color: #000000 
161 | }
162 | 
163 | span.vhdlkeyword { 
164 | 	color: #700070 
165 | }
166 | 
167 | span.vhdllogic { 
168 | 	color: #ff0000 
169 | }
170 | 
171 | 
172 | /* @end */
173 | 
174 | 


--------------------------------------------------------------------------------