Skip to content

Commit 90c20a0

Browse files
patrislav1patrislav1
committed
Add doxygen-awesome-css
1 parent dda774f commit 90c20a0

4 files changed

Lines changed: 81 additions & 84 deletions

File tree

‎.gitmodules‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
[submodule "doxygen-awesome-css"]
2+
path = doxygen-awesome-css
3+
url = https://github.com/jothepro/doxygen-awesome-css.git

‎Doxyfile‎

Lines changed: 9 additions & 84 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,12 @@
1-
# Doxyfile 1.8.11
1+
# Configuration for doxygen-awesome-css
2+
GENERATE_TREEVIEW = YES # required!
3+
DISABLE_INDEX = NO
4+
FULL_SIDEBAR = NO
5+
HTML_EXTRA_STYLESHEET = doxygen-awesome-css/doxygen-awesome.css \
6+
doxygen-awesome-css/doxygen-awesome-sidebar-only.css \
7+
doxygen-awesome-css/doxygen-awesome-sidebar-only-darkmode-toggle.css
8+
HTML_EXTRA_FILES = doxygen-awesome-css/doxygen-awesome-darkmode-toggle.js
9+
HTML_HEADER = docs/doxygen-header.html
210

311
DOXYFILE_ENCODING = UTF-8
412
PROJECT_NAME = "libudmaio"
@@ -516,26 +524,6 @@ HTML_OUTPUT = html
516524

517525
HTML_FILE_EXTENSION = .html
518526

519-
# The HTML_HEADER tag can be used to specify a user-defined HTML header file for
520-
# each generated HTML page. If the tag is left blank doxygen will generate a
521-
# standard header.
522-
#
523-
# To get valid HTML the header file that includes any scripts and style sheets
524-
# that doxygen needs, which is dependent on the configuration options used (e.g.
525-
# the setting GENERATE_TREEVIEW). It is highly recommended to start with a
526-
# default header using
527-
# doxygen -w html new_header.html new_footer.html new_stylesheet.css
528-
# YourConfigFile
529-
# and then modify the file new_header.html. See also section "Doxygen usage"
530-
# for information on how to generate the default header that doxygen normally
531-
# uses.
532-
# Note: The header is subject to change so you typically have to regenerate the
533-
# default header when upgrading to a newer version of doxygen. For a description
534-
# of the possible markers and block names see the documentation.
535-
# This tag requires that the tag GENERATE_HTML is set to YES.
536-
537-
HTML_HEADER =
538-
539527
# The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each
540528
# generated HTML page. If the tag is left blank doxygen will generate a standard
541529
# footer. See HTML_HEADER for more information on how to generate a default
@@ -546,41 +534,6 @@ HTML_HEADER =
546534

547535
HTML_FOOTER =
548536

549-
# The HTML_STYLESHEET tag can be used to specify a user-defined cascading style
550-
# sheet that is used by each HTML page. It can be used to fine-tune the look of
551-
# the HTML output. If left blank doxygen will generate a default style sheet.
552-
# See also section "Doxygen usage" for information on how to generate the style
553-
# sheet that doxygen normally uses.
554-
# Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as
555-
# it is more robust and this tag (HTML_STYLESHEET) will in the future become
556-
# obsolete.
557-
# This tag requires that the tag GENERATE_HTML is set to YES.
558-
559-
HTML_STYLESHEET =
560-
561-
# The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined
562-
# cascading style sheets that are included after the standard style sheets
563-
# created by doxygen. Using this option one can overrule certain style aspects.
564-
# This is preferred over using HTML_STYLESHEET since it does not replace the
565-
# standard style sheet and is therefore more robust against future updates.
566-
# Doxygen will copy the style sheet files to the output directory.
567-
# Note: The order of the extra style sheet files is of importance (e.g. the last
568-
# style sheet in the list overrules the setting of the previous ones in the
569-
# list). For an example see the documentation.
570-
# This tag requires that the tag GENERATE_HTML is set to YES.
571-
572-
HTML_EXTRA_STYLESHEET =
573-
574-
# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or
575-
# other source files which should be copied to the HTML output directory. Note
576-
# that these files will be copied to the base HTML output directory. Use the
577-
# $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these
578-
# files. In the HTML_STYLESHEET file, use the file name only. Also note that the
579-
# files will be copied as-is; there are no commands or markers available.
580-
# This tag requires that the tag GENERATE_HTML is set to YES.
581-
582-
HTML_EXTRA_FILES =
583-
584537
# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen
585538
# will adjust the colors in the style sheet and background images according to
586539
# this color. Hue is specified as an angle on a colorwheel, see
@@ -829,34 +782,6 @@ GENERATE_ECLIPSEHELP = NO
829782

830783
ECLIPSE_DOC_ID = org.doxygen.Project
831784

832-
# If you want full control over the layout of the generated HTML pages it might
833-
# be necessary to disable the index and replace it with your own. The
834-
# DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top
835-
# of each HTML page. A value of NO enables the index and the value YES disables
836-
# it. Since the tabs in the index contain the same information as the navigation
837-
# tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES.
838-
# The default value is: NO.
839-
# This tag requires that the tag GENERATE_HTML is set to YES.
840-
841-
DISABLE_INDEX = NO
842-
843-
# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
844-
# structure should be generated to display hierarchical information. If the tag
845-
# value is set to YES, a side panel will be generated containing a tree-like
846-
# index structure (just like the one that is generated for HTML Help). For this
847-
# to work a browser that supports JavaScript, DHTML, CSS and frames is required
848-
# (i.e. any modern browser). Windows users are probably better off using the
849-
# HTML help feature. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can
850-
# further fine-tune the look of the index. As an example, the default style
851-
# sheet generated by doxygen has an example that shows how to put an image at
852-
# the root of the tree instead of the PROJECT_NAME. Since the tree basically has
853-
# the same information as the tab index, you could consider setting
854-
# DISABLE_INDEX to YES when enabling this option.
855-
# The default value is: NO.
856-
# This tag requires that the tag GENERATE_HTML is set to YES.
857-
858-
GENERATE_TREEVIEW = NO
859-
860785
# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that
861786
# doxygen will group on one line in the generated HTML documentation.
862787
#

‎docs/doxygen-header.html‎

Lines changed: 68 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,68 @@
1+
<!-- HTML header for doxygen 1.9.1-->
2+
<!DOCTYPE html
3+
PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
4+
<html xmlns="http://www.w3.org/1999/xhtml">
5+
6+
<head>
7+
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8" />
8+
<meta http-equiv="X-UA-Compatible" content="IE=9" />
9+
<meta name="generator" content="Doxygen $doxygenversion" />
10+
<meta name="viewport" content="width=device-width, initial-scale=1" />
11+
<!--BEGIN PROJECT_NAME-->
12+
<title>$projectname: $title</title><!--END PROJECT_NAME-->
13+
<!--BEGIN !PROJECT_NAME-->
14+
<title>$title</title><!--END !PROJECT_NAME-->
15+
<link href="$relpath^tabs.css" rel="stylesheet" type="text/css" />
16+
<script type="text/javascript" src="$relpath^jquery.js"></script>
17+
<script type="text/javascript" src="$relpath^dynsections.js"></script>
18+
$treeview
19+
$search
20+
$mathjax
21+
<link href="$relpath^$stylesheet" rel="stylesheet" type="text/css" />
22+
$extrastylesheet
23+
<!-- ... other metadata & script includes ... -->
24+
<script type="text/javascript" src="$relpath^doxygen-awesome-darkmode-toggle.js"></script>
25+
<script type="text/javascript">
26+
DoxygenAwesomeDarkModeToggle.init()
27+
</script>
28+
</head>
29+
30+
<body>
31+
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
32+
33+
<!--BEGIN TITLEAREA-->
34+
<div id="titlearea">
35+
<table cellspacing="0" cellpadding="0">
36+
<tbody>
37+
<tr style="height: 56px;">
38+
<!--BEGIN PROJECT_LOGO-->
39+
<td id="projectlogo"><img alt="Logo" src="$relpath^$projectlogo" /></td>
40+
<!--END PROJECT_LOGO-->
41+
<!--BEGIN PROJECT_NAME-->
42+
<td id="projectalign" style="padding-left: 0.5em;">
43+
<div id="projectname">$projectname
44+
<!--BEGIN PROJECT_NUMBER-->&#160;<span
45+
id="projectnumber">$projectnumber</span><!--END PROJECT_NUMBER-->
46+
</div>
47+
<!--BEGIN PROJECT_BRIEF-->
48+
<div id="projectbrief">$projectbrief</div><!--END PROJECT_BRIEF-->
49+
</td>
50+
<!--END PROJECT_NAME-->
51+
<!--BEGIN !PROJECT_NAME-->
52+
<!--BEGIN PROJECT_BRIEF-->
53+
<td style="padding-left: 0.5em;">
54+
<div id="projectbrief">$projectbrief</div>
55+
</td>
56+
<!--END PROJECT_BRIEF-->
57+
<!--END !PROJECT_NAME-->
58+
<!--BEGIN DISABLE_INDEX-->
59+
<!--BEGIN SEARCHENGINE-->
60+
<td>$searchbox</td>
61+
<!--END SEARCHENGINE-->
62+
<!--END DISABLE_INDEX-->
63+
</tr>
64+
</tbody>
65+
</table>
66+
</div>
67+
<!--END TITLEAREA-->
68+
<!-- end header part -->

‎doxygen-awesome-css‎

Submodule doxygen-awesome-css added at a3c119b

0 commit comments

Comments
 (0)