From e8a8d781fa1b6a05af291ea702470c1b7ec0fb74 Mon Sep 17 00:00:00 2001 From: xmuli Date: Tue, 9 Mar 2021 17:12:49 +0800 Subject: [PATCH] =?UTF-8?q?docs:=20=E6=B7=BB=E5=8A=A0=20doxygen=20?= =?UTF-8?q?=E7=9A=84=20qt4=20style=20=E4=B8=BB=E9=A2=98?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit see: https://github.com/skozlovf/doxygen-qmi-style --- CustomQch/doxygen-qmi-style/README.md | 41 + CustomQch/doxygen-qmi-style/footer.html | 16 + CustomQch/doxygen-qmi-style/header.html | 48 + .../navtree/ftv2mlastnode.png | Bin 0 -> 285 bytes .../doxygen-qmi-style/navtree/ftv2mnode.png | Bin 0 -> 285 bytes .../navtree/ftv2plastnode.png | Bin 0 -> 277 bytes .../doxygen-qmi-style/navtree/ftv2pnode.png | Bin 0 -> 282 bytes .../doxygen-qmi-style/navtree/navtree.css | 117 ++ CustomQch/doxygen-qmi-style/qmi.css | 1026 +++++++++++++++++ CustomQch/doxygen-qmi-style/search/search.css | 233 ++++ 10 files changed, 1481 insertions(+) create mode 100644 CustomQch/doxygen-qmi-style/README.md create mode 100644 CustomQch/doxygen-qmi-style/footer.html create mode 100644 CustomQch/doxygen-qmi-style/header.html create mode 100644 CustomQch/doxygen-qmi-style/navtree/ftv2mlastnode.png create mode 100644 CustomQch/doxygen-qmi-style/navtree/ftv2mnode.png create mode 100644 CustomQch/doxygen-qmi-style/navtree/ftv2plastnode.png create mode 100644 CustomQch/doxygen-qmi-style/navtree/ftv2pnode.png create mode 100644 CustomQch/doxygen-qmi-style/navtree/navtree.css create mode 100644 CustomQch/doxygen-qmi-style/qmi.css create mode 100644 CustomQch/doxygen-qmi-style/search/search.css diff --git a/CustomQch/doxygen-qmi-style/README.md b/CustomQch/doxygen-qmi-style/README.md new file mode 100644 index 0000000..74c46cb --- /dev/null +++ b/CustomQch/doxygen-qmi-style/README.md @@ -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) diff --git a/CustomQch/doxygen-qmi-style/footer.html b/CustomQch/doxygen-qmi-style/footer.html new file mode 100644 index 0000000..8dd0b9a --- /dev/null +++ b/CustomQch/doxygen-qmi-style/footer.html @@ -0,0 +1,16 @@ + +
  • $generatedby + qmi style | + doxygen $doxygenversion
    • + + + + +
    +qmi style +
    +$generatedby doxygen $doxygenversion +
    + + + diff --git a/CustomQch/doxygen-qmi-style/header.html b/CustomQch/doxygen-qmi-style/header.html new file mode 100644 index 0000000..da8703a --- /dev/null +++ b/CustomQch/doxygen-qmi-style/header.html @@ -0,0 +1,48 @@ + + + + +$projectname: $title +$title + +$treeview +$search +$mathjax + + +
    + + +
    + + + + + + + + + + + + + + + + + + + + + + +
    +
    $projectname + $projectnumber +
    +
    $projectbrief
    +     		+
    $projectbrief
    +     		$searchbox
    +
    + diff --git a/CustomQch/doxygen-qmi-style/navtree/ftv2mlastnode.png b/CustomQch/doxygen-qmi-style/navtree/ftv2mlastnode.png new file mode 100644 index 0000000000000000000000000000000000000000..6dfeb5d52f533926acd970a380b44cd9ba61d2c1 GIT binary patch literal 285 zcmeAS@N?(olHy`uVBq!ia0vp^0zfRr!3HExu9B$%QjEnx?oJHr&dIz4a@dl*-CY>k z80IpZ@|^$A0Vu**;1OBOz`!jG!i)^F=12eq*-JcqUDxvg#;Y3(C)7_g=~auU&)C5cKB0u6Z|0-DOM=Du!VWBc zx|?~npNiKmrrp!3wO7`$2Rx}ecqZ=vi-q^B+TvrX7Z^TI2rECI<+ZZw(Ytx^i51K0 bnJSnVO9Kz}$v3M39m?S8>gTe~DWM4f7LZ+# literal 0 HcmV?d00001 diff --git a/CustomQch/doxygen-qmi-style/navtree/ftv2mnode.png b/CustomQch/doxygen-qmi-style/navtree/ftv2mnode.png new file mode 100644 index 0000000000000000000000000000000000000000..48e70f0374da028dd8f7632e70e6c6226ec931cf GIT binary patch literal 285 zcmeAS@N?(olHy`uVBq!ia0vp^0zfRr!3HExu9B$%QjEnx?oJHr&dIz4a@dl*-CY>k z80IpZ@|^$A0Vu**;1OBOz`!jG!i)^F=12eq*-JcqUD2BuPekxwOn08OA)?Qi19`K~@;F-JwEEe9gYKxDlUSRkk z80IpZ@|^$A0Vu**;1OBOz`!jG!i)^F=12eq*-JcqUD>Eak- zar*7$-Moh!1X>>cpTKQssT Un<7C=karn8UHx3vIVCg!0K86QkpKVy literal 0 HcmV?d00001 diff --git a/CustomQch/doxygen-qmi-style/navtree/ftv2pnode.png b/CustomQch/doxygen-qmi-style/navtree/ftv2pnode.png new file mode 100644 index 0000000000000000000000000000000000000000..02f42f7c3ae885782cb05c8a6c6ad6921456e428 GIT binary patch literal 282 zcmeAS@N?(olHy`uVBq!ia0vp^0zfRr!3HExu9B$%QjEnx?oJHr&dIz4a@dl*-CY>k z80IpZ@|^$A0Vu**;1OBOz`!jG!i)^F=12eq*-JcqUD6Gkwn-57 h3 { + margin-top: 0; +} + +.directory p { + margin: 0px; + white-space: nowrap; +} + +.directory div { + display: none; + margin: 0px; +} + +.directory img { + vertical-align: -30%; +} + +/* these are for tree view when not used as main index */ + +.directory-alt { + font-size: 100%; + font-weight: bold; +} + +.directory-alt h3 { + margin: 0px; + margin-top: 1em; + font-size: 11pt; +} + +.directory-alt > h3 { + margin-top: 0; +} + +.directory-alt p { + margin: 0px; + white-space: nowrap; +} + +.directory-alt div { + display: none; + margin: 0px; +} + +.directory-alt img { + vertical-align: -30%; +} + +/* @end */ + +div.dynheader { + margin-top: 8px; +} + +table.doxtable { + border-collapse:collapse; +} + +table.doxtable td, table.doxtable th { + border: 1px solid #2D4068; + padding: 3px 7px 2px; +} + +table.doxtable th { + background-color: #374F7F; + color: #FFFFFF; + font-size: 110%; + padding-bottom: 4px; + padding-top: 5px; + text-align:left; +} + +table.fieldtable { + width: 100%; + margin-bottom: 10px; + border: 1px solid #A8B8D9; + border-spacing: 0px; + -moz-border-radius: 4px; + -webkit-border-radius: 4px; + border-radius: 4px; + -moz-box-shadow: rgba(0, 0, 0, 0.15) 2px 2px 2px; + -webkit-box-shadow: 2px 2px 2px rgba(0, 0, 0, 0.15); + box-shadow: 2px 2px 2px rgba(0, 0, 0, 0.15); +} + +.fieldtable td, .fieldtable th { + padding: 3px 7px 2px; +} + +.fieldtable td.fieldtype, .fieldtable td.fieldname { + white-space: nowrap; + border-right: 1px solid #A8B8D9; + border-bottom: 1px solid #A8B8D9; + vertical-align: top; +} + +.fieldtable td.fielddoc { + border-bottom: 1px solid #A8B8D9; + width: 100%; +} + +.fieldtable tr:last-child td { + border-bottom: none; +} + +.fieldtable th { + background-image:url('nav_f.png'); + background-repeat:repeat-x; + background-color: #E2E8F2; + font-size: 90%; + color: #253555; + padding-bottom: 4px; + padding-top: 5px; + text-align:left; + -moz-border-radius-topleft: 4px; + -moz-border-radius-topright: 4px; + -webkit-border-top-left-radius: 4px; + -webkit-border-top-right-radius: 4px; + border-top-left-radius: 4px; + border-top-right-radius: 4px; + border-bottom: 1px solid #A8B8D9; +} + + +.tabsearch { + top: 0px; + left: 10px; + height: 36px; + background-image: url('tab_b.png'); + z-index: 101; + overflow: hidden; + font-size: 13px; +} + +.navpath ul +{ + font-size: 11px; + height:30px; + line-height:30px; + border-top: 1px solid #C4C4C4; + overflow:hidden; + margin:0px; + padding:0px; +} + +/** TODO: use image as marker. */ +.navpath li +{ + list-style-type:disc; + float:left; + padding-left:5px; + padding-right:5px; + margin-right: 25px; +} + +.navpath li.navelem a +{ + height:32px; + display:block; + text-decoration: none; + outline: none; +} + +.navpath li.navelem a:hover +{ + text-decoration: underline; +} + +.navpath li.footer +{ + list-style-type:none; + float:right; + padding-bottom: 6px; + background-image:none; + background-repeat:no-repeat; + background-position:right; + font-size: 8pt; +} + + +div.summary +{ + float: right; + font-size: 8pt; + padding-right: 5px; + width: 50%; + text-align: right; +} + +div.summary a +{ + white-space: nowrap; +} + +div.ingroups +{ + margin-left: 5px; + font-size: 8pt; + padding-left: 5px; + width: 50%; + text-align: left; +} + +div.ingroups a +{ + white-space: nowrap; +} + +div.header +{ + /*background-image:url('nav_h.png'); + background-repeat:repeat-x; + background-color: #F9FAFC;*/ + margin-top: 10px; + /*border-bottom: 1px solid #C4CFE5;*/ +} + +div.headertitle +{ + padding: 5px 5px 5px 7px; +} + + +dl.note, dl.warning, dl.attention, dl.pre, dl.post, dl.invariant, dl.deprecated, dl.todo, dl.test, dl.bug +{ + border-left:4px solid; + padding: 0 0 0 6px; +} + +dl.note +{ + border-color: #D0C000; +} + +dl.warning, dl.attention +{ + border-color: #FF0000; +} + +dl.pre, dl.post, dl.invariant +{ + border-color: #00D000; +} + +dl.deprecated +{ + border-color: #505050; +} + +dl.todo +{ + border-color: #00C0E0; +} + +dl.test +{ + border-color: #3030E0; +} + +dl.bug +{ + border-color: #C08050; +} + +.title +{ + font-size: 150%; + font-weight: bold; + margin: 10px 2px; +} + +.image +{ + text-align: center; +} + +.dotgraph +{ + text-align: center; +} + +.mscgraph +{ + text-align: center; +} + +.caption +{ + font-weight: bold; +} + +div.zoom +{ + border: 1px solid #E6E6E6; +} + +dl.citelist { + margin-bottom:50px; +} + +dl.citelist dt { + color:#334975; + float:left; + font-weight:bold; + margin-right:10px; + padding:5px; +} + +dl.citelist dd { + margin:2px 0; + padding:5px 0; +} + +@media print +{ + #top { display: none; } + #side-nav { display: none; } + #nav-path { display: none; } + body { overflow:visible; } + h1, h2, h3, h4, h5, h6 { page-break-after: avoid; } + .summary { display: none; } + .memitem { page-break-inside: avoid; } + #doc-content + { + margin-left:0 !important; + height:auto !important; + width:auto !important; + overflow:inherit; + display:inline; + } + pre.fragment + { + overflow: visible; + text-wrap: unrestricted; + white-space: -moz-pre-wrap; /* Moz */ + white-space: -pre-wrap; /* Opera 4-6 */ + white-space: -o-pre-wrap; /* Opera 7 */ + white-space: pre-wrap; /* CSS3 */ + word-wrap: break-word; /* IE 5.5+ */ + } +} + diff --git a/CustomQch/doxygen-qmi-style/search/search.css b/CustomQch/doxygen-qmi-style/search/search.css new file mode 100644 index 0000000..db335c0 --- /dev/null +++ b/CustomQch/doxygen-qmi-style/search/search.css @@ -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; +}