docs: 添加 doxygen 的 qt4 style 主题
see: https://github.com/skozlovf/doxygen-qmi-style
This commit is contained in:
parent
0e9b53fcea
commit
e8a8d781fa
41
CustomQch/doxygen-qmi-style/README.md
Normal file
41
CustomQch/doxygen-qmi-style/README.md
Normal file
@ -0,0 +1,41 @@
|
|||||||
|
Qmi is a "**Q**t **Mi**nimal" theme for the Doxygen HTML documentation.
|
||||||
|
It based on official Qt4 documentation's style.
|
||||||
|
|
||||||
|
# How to setup
|
||||||
|
|
||||||
|
To use `qmi` style make the following changes in your Doxyfile:
|
||||||
|
|
||||||
|
# Project section
|
||||||
|
BRIEF_MEMBER_DESC = NO
|
||||||
|
|
||||||
|
# HTML section
|
||||||
|
HTML_HEADER = ${path_to_qmi}/header.html
|
||||||
|
HTML_FOOTER = ${path_to_qmi}/footer.html
|
||||||
|
HTML_STYLESHEET = ${path_to_qmi}/qmi.css
|
||||||
|
|
||||||
|
**NOTE**:
|
||||||
|
|
||||||
|
* If you use **_tree navigation panel_** then copy contents of the `navtree` dir to the documentation html dir.
|
||||||
|
* If you use **_search_** feature then copy contents of the `search` dir to the `html/search`.
|
||||||
|
|
||||||
|
# Examples
|
||||||
|
|
||||||
|
If you want to see `qmi` style in action then use the following links with examples:
|
||||||
|
|
||||||
|
* [Qwt docs](http://skozlovf.github.com/doxygen-qmi-style/qwt)
|
||||||
|
* [libxml++ docs](http://skozlovf.github.com/doxygen-qmi-style/libxmlpp) (with tree navigation and search)
|
||||||
|
|
||||||
|
|
||||||
|
## Screenshots
|
||||||
|
|
||||||
|
* **Main page**:
|
||||||
|
|
||||||
|
![](http://skozlovf.github.com/doxygen-qmi-style/shot1.png)
|
||||||
|
|
||||||
|
* **Index page**:
|
||||||
|
|
||||||
|
![](http://skozlovf.github.com/doxygen-qmi-style/shot2.png)
|
||||||
|
|
||||||
|
* **Member description**:
|
||||||
|
|
||||||
|
![](http://skozlovf.github.com/doxygen-qmi-style/shot3.png)
|
16
CustomQch/doxygen-qmi-style/footer.html
Normal file
16
CustomQch/doxygen-qmi-style/footer.html
Normal file
@ -0,0 +1,16 @@
|
|||||||
|
<!--BEGIN GENERATE_TREEVIEW-->
|
||||||
|
<li class="footer">$generatedby
|
||||||
|
<span class="qmi"><a href="http://github.com/skozlovf/doxygen-qmi-style">qmi style</a> |</span>
|
||||||
|
<a href="http://www.doxygen.org/index.html">doxygen</a> $doxygenversion </li>
|
||||||
|
</ul>
|
||||||
|
</div>
|
||||||
|
<!--END GENERATE_TREEVIEW-->
|
||||||
|
<!--BEGIN !GENERATE_TREEVIEW-->
|
||||||
|
<hr class="footer"/><small>
|
||||||
|
<span class="qmi"><a href="http://github.com/skozlovf/doxygen-qmi-style">qmi style</a></span>
|
||||||
|
<address class="footer">
|
||||||
|
$generatedby <a href="http://www.doxygen.org/index.html">doxygen</a> $doxygenversion
|
||||||
|
</small></address>
|
||||||
|
<!--END !GENERATE_TREEVIEW-->
|
||||||
|
</body>
|
||||||
|
</html>
|
48
CustomQch/doxygen-qmi-style/header.html
Normal file
48
CustomQch/doxygen-qmi-style/header.html
Normal file
@ -0,0 +1,48 @@
|
|||||||
|
<!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"/>
|
||||||
|
<!--BEGIN PROJECT_NAME--><title>$projectname: $title</title><!--END PROJECT_NAME-->
|
||||||
|
<!--BEGIN !PROJECT_NAME--><title>$title</title><!--END !PROJECT_NAME-->
|
||||||
|
<link href="$relpath$qmi.css" rel="stylesheet" type="text/css" />
|
||||||
|
$treeview
|
||||||
|
$search
|
||||||
|
$mathjax
|
||||||
|
</head>
|
||||||
|
<body>
|
||||||
|
<div id="top"><!-- do not remove this div! -->
|
||||||
|
|
||||||
|
<!--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 style="padding-left: 0.5em;"-->
|
||||||
|
<td>
|
||||||
|
<div id="projectname">$projectname
|
||||||
|
<!--BEGIN PROJECT_NUMBER--><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-->
|
BIN
CustomQch/doxygen-qmi-style/navtree/ftv2mlastnode.png
Normal file
BIN
CustomQch/doxygen-qmi-style/navtree/ftv2mlastnode.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 285 B |
BIN
CustomQch/doxygen-qmi-style/navtree/ftv2mnode.png
Normal file
BIN
CustomQch/doxygen-qmi-style/navtree/ftv2mnode.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 285 B |
BIN
CustomQch/doxygen-qmi-style/navtree/ftv2plastnode.png
Normal file
BIN
CustomQch/doxygen-qmi-style/navtree/ftv2plastnode.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 277 B |
BIN
CustomQch/doxygen-qmi-style/navtree/ftv2pnode.png
Normal file
BIN
CustomQch/doxygen-qmi-style/navtree/ftv2pnode.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 282 B |
117
CustomQch/doxygen-qmi-style/navtree/navtree.css
Normal file
117
CustomQch/doxygen-qmi-style/navtree/navtree.css
Normal file
@ -0,0 +1,117 @@
|
|||||||
|
#nav-tree .children_ul {
|
||||||
|
margin:0;
|
||||||
|
padding:4px;
|
||||||
|
}
|
||||||
|
|
||||||
|
#nav-tree ul {
|
||||||
|
list-style:none outside none;
|
||||||
|
margin:0px;
|
||||||
|
padding:0px;
|
||||||
|
}
|
||||||
|
|
||||||
|
#nav-tree li {
|
||||||
|
white-space:nowrap;
|
||||||
|
margin:0px;
|
||||||
|
padding:0px;
|
||||||
|
}
|
||||||
|
|
||||||
|
#nav-tree .plus {
|
||||||
|
margin:0px;
|
||||||
|
}
|
||||||
|
|
||||||
|
#nav-tree .selected {
|
||||||
|
background-image: none;
|
||||||
|
background-color: #B0B0B0;
|
||||||
|
color: #fff;
|
||||||
|
}
|
||||||
|
|
||||||
|
#nav-tree img {
|
||||||
|
margin:0px;
|
||||||
|
padding:0px;
|
||||||
|
border:0px;
|
||||||
|
vertical-align: middle;
|
||||||
|
}
|
||||||
|
|
||||||
|
#nav-tree a {
|
||||||
|
text-decoration:none;
|
||||||
|
padding:0px;
|
||||||
|
margin:0px;
|
||||||
|
outline:none;
|
||||||
|
}
|
||||||
|
|
||||||
|
#nav-tree .label {
|
||||||
|
margin:0px;
|
||||||
|
padding:0px;
|
||||||
|
}
|
||||||
|
|
||||||
|
#nav-tree .label a {
|
||||||
|
padding:2px;
|
||||||
|
}
|
||||||
|
|
||||||
|
#nav-tree .selected a {
|
||||||
|
text-decoration:none;
|
||||||
|
padding:2px;
|
||||||
|
margin:0px;
|
||||||
|
color:#fff;
|
||||||
|
}
|
||||||
|
|
||||||
|
#nav-tree .children_ul {
|
||||||
|
margin:0px;
|
||||||
|
padding:0px;
|
||||||
|
}
|
||||||
|
|
||||||
|
#nav-tree .item {
|
||||||
|
margin:0px;
|
||||||
|
padding:0px;
|
||||||
|
}
|
||||||
|
|
||||||
|
#nav-tree {
|
||||||
|
padding: 0px 0px;
|
||||||
|
background-image:none;
|
||||||
|
background-color: #F6F6F6;
|
||||||
|
font-size:14px;
|
||||||
|
overflow:auto;
|
||||||
|
}
|
||||||
|
|
||||||
|
#doc-content {
|
||||||
|
overflow:auto;
|
||||||
|
display:block;
|
||||||
|
padding:0px;
|
||||||
|
margin:0px;
|
||||||
|
}
|
||||||
|
|
||||||
|
#side-nav {
|
||||||
|
padding:0 4px 0 0;
|
||||||
|
margin: 0px;
|
||||||
|
display:block;
|
||||||
|
position: absolute;
|
||||||
|
left: 0px;
|
||||||
|
width: 300px;
|
||||||
|
}
|
||||||
|
|
||||||
|
.ui-resizable .ui-resizable-handle {
|
||||||
|
display:block;
|
||||||
|
}
|
||||||
|
|
||||||
|
.ui-resizable-e {
|
||||||
|
background: none;
|
||||||
|
background-color: #EBEBEB;
|
||||||
|
cursor:e-resize;
|
||||||
|
height:100%;
|
||||||
|
right:0;
|
||||||
|
top:0;
|
||||||
|
width:4px;
|
||||||
|
}
|
||||||
|
|
||||||
|
.ui-resizable-handle {
|
||||||
|
display:none;
|
||||||
|
font-size:0.1px;
|
||||||
|
position:absolute;
|
||||||
|
z-index:1;
|
||||||
|
}
|
||||||
|
|
||||||
|
#nav-tree-contents {
|
||||||
|
margin: 6px 0px 0px 0px;
|
||||||
|
}
|
||||||
|
|
||||||
|
|
1026
CustomQch/doxygen-qmi-style/qmi.css
Normal file
1026
CustomQch/doxygen-qmi-style/qmi.css
Normal file
File diff suppressed because it is too large
Load Diff
233
CustomQch/doxygen-qmi-style/search/search.css
Normal file
233
CustomQch/doxygen-qmi-style/search/search.css
Normal file
@ -0,0 +1,233 @@
|
|||||||
|
/*---------------- Search Box */
|
||||||
|
|
||||||
|
#FSearchBox {
|
||||||
|
float: left;
|
||||||
|
}
|
||||||
|
|
||||||
|
#MSearchBox {
|
||||||
|
white-space : nowrap;
|
||||||
|
position: absolute;
|
||||||
|
float: none;
|
||||||
|
display: inline;
|
||||||
|
margin-top: 3px;
|
||||||
|
right: 0px;
|
||||||
|
width: 170px;
|
||||||
|
z-index: 102;
|
||||||
|
}
|
||||||
|
|
||||||
|
#MSearchBox .left
|
||||||
|
{
|
||||||
|
display:block;
|
||||||
|
position:absolute;
|
||||||
|
left:10px;
|
||||||
|
width:20px;
|
||||||
|
height:19px;
|
||||||
|
background:url('search_l.png') no-repeat;
|
||||||
|
background-position:right;
|
||||||
|
}
|
||||||
|
|
||||||
|
#MSearchSelect {
|
||||||
|
display:block;
|
||||||
|
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;
|
||||||
|
border:none;
|
||||||
|
width:116px;
|
||||||
|
margin-left:20px;
|
||||||
|
padding-left:4px;
|
||||||
|
color: #909090;
|
||||||
|
outline: none;
|
||||||
|
font: 9pt Arial, Verdana, sans-serif;
|
||||||
|
}
|
||||||
|
|
||||||
|
#FSearchBox #MSearchField {
|
||||||
|
margin-left:15px;
|
||||||
|
}
|
||||||
|
|
||||||
|
#MSearchBox .right {
|
||||||
|
display:block;
|
||||||
|
position:absolute;
|
||||||
|
right:10px;
|
||||||
|
top:0px;
|
||||||
|
width:20px;
|
||||||
|
height:19px;
|
||||||
|
background:url('search_r.png') no-repeat;
|
||||||
|
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;
|
||||||
|
}
|
||||||
|
|
||||||
|
.MSearchBoxActive #MSearchField {
|
||||||
|
color: #000000;
|
||||||
|
}
|
||||||
|
|
||||||
|
/*---------------- Search filter selection */
|
||||||
|
|
||||||
|
#MSearchSelectWindow {
|
||||||
|
display: none;
|
||||||
|
position: absolute;
|
||||||
|
left: 0; top: 0;
|
||||||
|
border: 1px solid #E6E6E6;
|
||||||
|
background-color: #F6F6F6;
|
||||||
|
z-index: 1;
|
||||||
|
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: #B0B0B0;
|
||||||
|
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 #8A8A8A;
|
||||||
|
background-color: #F6F6F6;
|
||||||
|
}
|
||||||
|
|
||||||
|
/* ----------------------------------- */
|
||||||
|
|
||||||
|
|
||||||
|
#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: #00732F;
|
||||||
|
font-family: Arial, Verdana, sans-serif;
|
||||||
|
text-decoration: none;
|
||||||
|
outline: none;
|
||||||
|
}
|
||||||
|
|
||||||
|
a.SRScope {
|
||||||
|
display: block;
|
||||||
|
color: #00732F;
|
||||||
|
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;
|
||||||
|
}
|
||||||
|
|
||||||
|
.SRPage .SRStatus {
|
||||||
|
padding: 2px 5px;
|
||||||
|
font-size: 8pt;
|
||||||
|
font-style: italic;
|
||||||
|
}
|
||||||
|
|
||||||
|
.SRResult {
|
||||||
|
display: none;
|
||||||
|
}
|
||||||
|
|
||||||
|
DIV.searchresults {
|
||||||
|
margin-left: 10px;
|
||||||
|
margin-right: 10px;
|
||||||
|
}
|
Loading…
Reference in New Issue
Block a user