Skip to content

Commit bb04a7f

Browse files
committed
2.0.1
1 parent fed0986 commit bb04a7f

File tree

6 files changed

+456
-2
lines changed

6 files changed

+456
-2
lines changed

doc/DOC_MAN_SPX.pdf

-1.08 KB
Binary file not shown.

doc/Doxyfile

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -68,8 +68,8 @@ STRIP_CODE_COMMENTS = NO
6868
GENERATE_HTML = YES
6969
HTML_OUTPUT = ./html
7070
HTML_FILE_EXTENSION = .html
71-
#Spexygen HTML_HEADER =
72-
#Spexygen HTML_FOOTER =
71+
HTML_HEADER = ./spexy-header.html
72+
HTML_FOOTER = ./spexy-footer.html
7373
HTML_STYLESHEET =
7474
#Spexygen HTML_EXTRA_STYLESHEET =
7575
#Spexygen HTML_EXTRA_FILES =
@@ -136,6 +136,8 @@ EXTRA_SEARCH_MAPPINGS =
136136
GENERATE_LATEX = NO
137137
LATEX_OUTPUT = ./latex
138138
LATEX_CMD_NAME = latex
139+
LATEX_HEADER = ./spexy-header.tex
140+
LATEX_FOOTER = ./spexy-footer.tex
139141
MAKEINDEX_CMD_NAME = makeindex
140142
LATEX_MAKEINDEX_CMD = makeindex
141143
COMPACT_LATEX = NO

doc/spexy-footer.html

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
<!-- HTML footer for doxygen 1.9.2-->
2+
<!-- start footer part -->
3+
<!--BEGIN GENERATE_TREEVIEW-->
4+
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
5+
<ul>
6+
$navpath
7+
<li class="footer">
8+
<a title="Quantum Leaps: Modern Embedded Software" href="https://www.state-machine.com">&copy; 2005-$year Quantum Leaps</a> &nbsp;|&nbsp; <a title="help" href="help.html">Using Online Help</a> &nbsp;|&nbsp; <b>$projectname $projectnumber</b> &nbsp;|&nbsp; created with <a title="Spexygen: traceable specifications" href="https://www.state-machine.com/spexygen"><em>Spexygen</em></a>
9+
<hr class="footer"/><address class="footer"><small>
10+
<a title="Quantum Leaps: Modern Embedded Software" href="https://www.state-machine.com">&copy; 2005-$year Quantum Leaps</a> &nbsp;|&nbsp; <a title="help" href="help.html">Using Online Help</a> &nbsp;|&nbsp; <b>$projectname $projectnumber</b> &nbsp;|&nbsp; created with <a title="Spexygen: traceable specifications" href="https://www.state-machine.com/spexygen"><em>Spexygen</em></a>
11+
</small></address>
12+
</li>
13+
</ul>
14+
</div>
15+
<!--END GENERATE_TREEVIEW-->
16+
<!--BEGIN !GENERATE_TREEVIEW-->
17+
<hr class="footer"/><address class="footer"><small>
18+
<b>$projectname $projectnumber</b> &nbsp;|&nbsp; created with <a title="Spexygen: traceable specifications" href="https://www.state-machine.com/spexygen"><em>Spexygen</em></a>
19+
</small></address>
20+
<!--END !GENERATE_TREEVIEW-->
21+
</body>
22+
</html>

doc/spexy-footer.tex

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
% original: https://github.com/doxygen/doxygen/blob/master/templates/latex/footer.tex
2+
% modified by Quantum Leaps on 22-10-27
3+
4+
%--- End generated contents ---
5+
6+
%%BEGIN CITATIONS_PRESENT
7+
% Bibliography
8+
\newpage
9+
\phantomsection
10+
11+
%%BEGIN !PDF_HYPERLINKS
12+
\clearemptydoublepage
13+
%%BEGIN COMPACT_LATEX
14+
\addcontentsline{toc}{section}{$latexcitereference}
15+
%%END COMPACT_LATEX
16+
%%BEGIN !COMPACT_LATEX
17+
\addcontentsline{toc}{chapter}{$latexcitereference}
18+
%%END !COMPACT_LATEX
19+
\printindex
20+
%%END !PDF_HYPERLINKS
21+
22+
\bibliographystyle{$latexbibstyle}
23+
\bibliography{$latexbibfiles}
24+
%%BEGIN PDF_HYPERLINKS
25+
%%BEGIN COMPACT_LATEX
26+
\addcontentsline{toc}{section}{$latexcitereference}
27+
%%END COMPACT_LATEX
28+
%%BEGIN !COMPACT_LATEX
29+
\addcontentsline{toc}{chapter}{$latexcitereference}
30+
%%END !COMPACT_LATEX
31+
%%END PDF_HYPERLINKS
32+
33+
%%END CITATIONS_PRESENT
34+
35+
% Index
36+
%%BEGIN !COMPACT_LATEX
37+
\backmatter
38+
%%END !COMPACT_LATEX
39+
\newpage
40+
\phantomsection
41+
\clearemptydoublepage
42+
%%BEGIN COMPACT_LATEX
43+
\addcontentsline{toc}{section}{\indexname}
44+
%%END COMPACT_LATEX
45+
%%BEGIN !COMPACT_LATEX
46+
\addcontentsline{toc}{chapter}{\indexname}
47+
%%END !COMPACT_LATEX
48+
\printindex
49+
50+
% Required for some languages (in combination with latexdocumentpre from the header)
51+
$latexdocumentpost
52+
\end{document}
53+

doc/spexy-header.html

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2+
<html xmlns="http://www.w3.org/1999/xhtml">
3+
<head>
4+
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
5+
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
6+
<meta name="viewport" content="width=device-width, initial-scale=1"/>
7+
8+
<!--BEGIN PROJECT_NAME--><title>$projectname: $title</title><!--END PROJECT_NAME-->
9+
<!--BEGIN !PROJECT_NAME--><title>$title</title><!--END !PROJECT_NAME-->
10+
<link href="$relpath^tabs.css" rel="stylesheet" type="text/css"/>
11+
<script type="text/javascript" src="$relpath^jquery.js"></script>
12+
<script type="text/javascript" src="$relpath^dynsections.js"></script>
13+
<script type="text/javascript" src="$relpath^doxygen-awesome-darkmode-toggle.js"></script>
14+
<script type="text/javascript" src="$relpath^doxygen-awesome-fragment-copy-button.js"></script>
15+
<script type="text/javascript" src="$relpath^doxygen-awesome-paragraph-link.js"></script>
16+
<script type="text/javascript" src="$relpath^ql-preview.js"></script>
17+
<script type="text/javascript">
18+
DoxygenAwesomeFragmentCopyButton.init()
19+
DoxygenAwesomeDarkModeToggle.init()
20+
DoxygenAwesomeParagraphLink.init()
21+
</script>
22+
$treeview
23+
$search
24+
$mathjax
25+
<link href="$relpath^$stylesheet" rel="stylesheet" type="text/css" />
26+
$extrastylesheet
27+
</head>
28+
<body>
29+
30+
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
31+
32+
<!--BEGIN TITLEAREA-->
33+
<div id="titlearea">
34+
<div id="projectlogo">
35+
<a href="https://www.state-machine.com/spexygen" title="Spexygen"><img alt="Logo" src="$relpath^$projectlogo"/></a>
36+
</div>
37+
<!--END PROJECT_LOGO-->
38+
<!--BEGIN PROJECT_NAME-->
39+
<div id="projectname">
40+
$projectname
41+
<!--BEGIN PROJECT_NUMBER-->&nbsp;<span id="projectnumber">$projectnumber</span><!--END PROJECT_NUMBER-->
42+
</div>
43+
<!--BEGIN PROJECT_BRIEF--><div id="projectbrief">$projectbrief</div><!--END PROJECT_BRIEF-->
44+
<!--END PROJECT_NAME-->
45+
<!--BEGIN DISABLE_INDEX-->
46+
<!--BEGIN SEARCHENGINE-->
47+
$searchbox
48+
<!--END SEARCHENGINE-->
49+
<!--END DISABLE_INDEX-->
50+
</div>
51+
<!--END TITLEAREA-->
52+
<!-- end header part -->
53+

0 commit comments

Comments
 (0)