diff --git a/doc/CMakeLists.txt b/doc/CMakeLists.txt index 0668a75..e8fe0ff 100644 --- a/doc/CMakeLists.txt +++ b/doc/CMakeLists.txt @@ -2,8 +2,12 @@ find_package(Doxygen) if (DOXYGEN_FOUND) set(INPUT_FILE ${CMAKE_CURRENT_SOURCE_DIR}/Doxyfile.in) + set(INPUT_CSS_FILE ${CMAKE_CURRENT_SOURCE_DIR}/qtify.css) + set(INPUT_README_FILE ${CMAKE_CURRENT_SOURCE_DIR}/../README.md) set(OUTPUT_DIR ${CMAKE_CURRENT_BINARY_DIR}) set(OUTPUT_FILE ${OUTPUT_DIR}/Doxyfile) + set(OUTPUT_CSS_FILE ${OUTPUT_DIR}/qtify.css) configure_file(${INPUT_FILE} ${OUTPUT_FILE} @ONLY) + file(COPY ${INPUT_CSS_FILE} ${INPUT_README_FILE} DESTINATION ${OUTPUT_DIR}) add_custom_target(doc ${DOXYGEN_EXECUTABLE} ${OUTPUT_FILE} WORKING_DIRECTORY ${OUTPUT_DIR} COMMENT "Generating the API documentation with Doxygen" VERBATIM) endif() diff --git a/doc/Doxyfile.in b/doc/Doxyfile.in index cd07162..805ad3f 100644 --- a/doc/Doxyfile.in +++ b/doc/Doxyfile.in @@ -140,7 +140,7 @@ INLINE_INHERITED_MEMB = NO # shortest path that makes the file name unique will be used # The default value is: YES. -FULL_PATH_NAMES = YES +FULL_PATH_NAMES = NO # The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path. # Stripping is only done if one of the specified strings matches the left-hand @@ -752,7 +752,7 @@ WARN_LOGFILE = # spaces. # Note: If this tag is empty the current directory is searched. -INPUT = @CMAKE_CURRENT_SOURCE_DIR@/../lib +INPUT = @CMAKE_CURRENT_SOURCE_DIR@/../lib @CMAKE_CURRENT_SOURCE_DIR@/../README.md # This tag can be used to specify the character encoding of the source files # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses @@ -888,7 +888,7 @@ FILTER_SOURCE_PATTERNS = # (index.html). This can be useful if you have a project on for instance GitHub # and want to reuse the introduction page also for the doxygen output. -USE_MDFILE_AS_MAINPAGE = +USE_MDFILE_AS_MAINPAGE = README.md #--------------------------------------------------------------------------- # Configuration options related to source browsing @@ -1079,7 +1079,7 @@ HTML_STYLESHEET = # list). For an example see the documentation. # This tag requires that the tag GENERATE_HTML is set to YES. -HTML_EXTRA_STYLESHEET = +HTML_EXTRA_STYLESHEET = qtify.css # The HTML_EXTRA_FILES tag can be used to specify one or more extra images or # other source files which should be copied to the HTML output directory. Note diff --git a/doc/qtify.css b/doc/qtify.css new file mode 100644 index 0000000..537d875 --- /dev/null +++ b/doc/qtify.css @@ -0,0 +1,1053 @@ +/** + * Qt like CSS for doxygen based on 1.8.6 + * + * Frank Enderle + */ + +body, table, div, p, dl { + font: 400 13px/1.3 Verdana,DejaVu Sans,Geneva,sans-serif; +} + +/* @group Heading Levels */ + +h1.groupheader { + font-size: 16px; +} + +.title { + font: 700 18px Verdana,DejaVu Sans,Geneva,sans-serif; + margin: 10px 2px; +} + +h2.groupheader { + border: 0; + color: #363534; + font-size: 16px; + font-weight: 600; +} + +h3.groupheader { + font-size: 13px; +} + +h1, h2, h3, h4, h5, h6 { + -webkit-transition: none; + -moz-transition: none; + -ms-transition: none; + -o-transition: none; + transition: none; +} + +h1.glow, h2.glow, h3.glow, h4.glow, h5.glow, h6.glow { + text-shadow: none; +} + +dt { +} + +div.multicol { +} + +p.startli, p.startdd { +} + +p.starttd { +} + +p.endli { +} + +p.enddd { +} + +p.endtd { +} + +/* @end */ + +caption { +} + +span.legend { +} + +h3.version { +} + +div.qindex, div.navtab { + background-color: #F6F6F6; + border: 1px solid #E6E6E6; +} + +div.qindex, div.navpath { + line-height: 1.5; +} + +div.navtab { +} + +/* @group Link Styling */ + +a { + color: #00732F; +} + +.contents a:visited { + color: #00732F; +} + +a:hover { + text-decoration: none; +} + +a.qindex { +} + +a.qindexHL { +} + +.contents a.qindexHL:visited { +} + +a.el { + font-weight: normal; +} + +a.elRef { +} + +a.code, a.code:visited, a.line, a.line:visited { + color: #00732F; +} + +a.codeRef, a.codeRef:visited, a.lineRef, a.lineRef:visited { + color: #00732F; +} + +/* @end */ + +dl.el { +} + +pre.fragment { +} + +div.fragment { +} + +div.line { + -webkit-transition-duration: 0; + -moz-transition-duration: 0; + -ms-transition-duration: 0; + -o-transition-duration: 0; + transition-duration: 0; +} + +div.line.glow { + background-color: auto; + box-shadow: none; +} + +span.lineno { +} + +span.lineno a { +} + +span.lineno a:hover { +} + +div.ah { + background: none; + background-color: #F6F6F6; + color: #66666E; + border: 1px solid #E6E6E6; + border-radius: 7px; + -webkit-border-radius: 7px; + -moz-border-radius: 7px; + box-shadow: none; + -webkit-box-shadow: none; + -moz-box-shadow: none; +} + +div.groupHeader { +} + +div.groupText { +} + +body { + color: #363534; +} + +div.contents { +} + +td.indexkey { +} + +td.indexvalue { +} + +tr.memlist { +} + +p.formulaDsp { +} + +img.formulaDsp { +} + +img.formulaInl { +} + +div.center { +} + +div.center img { +} + +address.footer { +} + +img.footer { + display: none; +} + +/* addition */ +.footer a:before { + content: "Doxygen"; +} +/* --- */ + +/* @group Code Colorization */ + +span.keyword { +} + +span.keywordtype { +} + +span.keywordflow { +} + +span.comment { +} + +span.preprocessor { +} + +span.stringliteral { +} + +span.charliteral { +} + +span.vhdldigit { +} + +span.vhdlchar { +} + +span.vhdlkeyword { +} + +span.vhdllogic { +} + +blockquote { +} + +/* @end */ + +.search { +} + +form.search { +} + +input.search { +} + +td.tiny { +} + +.dirtab { +} + +th.dirtab { +} + +hr { + border-top: 1px solid #E6E6E6; + margin: 10px 8px 0 12px; +} + +hr.footer { +} + +/* @group Member Descriptions */ + +table.memberdecls { + font-size: 13px; +} + +/* addition */ + +table.memberdecls a { + font-weight: 600; +} + +table.memberdecls .memItemLeft { + border: solid #E6E6E6; + border-width: 0 0 0 1px; +} + +table.memberdecls .memItemRight { + border: solid #E6E6E6; + border-width: 0 1px 0 0; +} + +table.memberdecls tr:nth-child(2) .memItemLeft { + border-top-width: 1px; + border-top-left-radius: 7px; + padding-top: 6px; +} + +table.memberdecls tr:nth-child(2) .memItemRight { + border-top-width: 1px; + border-top-right-radius: 7px; + padding-top: 6px; +} + +table.memberdecls tr:nth-last-child(2) .memItemLeft { + border-bottom-width: 1px; + border-bottom-left-radius: 7px; + padding-bottom: 6px; +} + +table.memberdecls tr:nth-last-child(2) .memItemRight { + border-bottom-width: 1px; + border-bottom-right-radius: 7px; + padding-bottom: 6px; +} + +/* --- */ + +.memberdecls td, .fieldtable tr { + -webkit-transition-duration: 0; + -moz-transition-duration: 0; + -ms-transition-duration: 0; + -o-transition-duration: 0; + transition-duration: 0; +} + +.memberdecls td.glow, .fieldtable tr.glow { + background-color: auto; + box-shadow: 0; +} + +.mdescLeft, .mdescRight, +.memItemLeft, .memItemRight, +.memTemplItemLeft, .memTemplItemRight, .memTemplParams { + width: auto; + background-color: #F6F6F6; +} + +.mdescLeft, .mdescRight { +} + +/* addition */ +.mdescLeft { + padding: 3px 10px 3px 15px; +} + +.mdescRight { + padding: 3px 15px 3px 10px; +} +/* --- */ + +.memSeparator { + display: none; +} + +.memItemLeft, .memTemplItemLeft { +} + +.memItemRight { + padding-right: 8px; +} + +.memTemplParams { +} + +/* @end */ + +/* @group Member Details */ + +/* Styles for detailed member documentation */ + +.memtemplate { +} + +.memnav { +} + +.mempage { +} + +.memitem { + margin-bottom: 20px; + -webkit-transition-duration: 0; + -moz-transition-duration: 0; + -ms-transition-duration: 0; + -o-transition-duration: 0; + transition-duration: 0; +} + +.memitem.glow { + box-shadow: none; +} + +.memname { + font-size: 13px; +} + +.memname td { +} + +.memproto, dl.reflist dt { + border: 1px solid #E6E6E6; + padding: 5px 10px; + color: #363534; + text-shadow: none; + background: none; + background-color: #F6F6F6; + box-shadow: none; + border-radius: 7px; + -moz-box-shadow: none; + -moz-border-radius: 7px; + -webkit-box-shadow: none; + -webkit-border-radius: 7px; +} + +/* additional */ +.memproto .memname { + font-weight: bold; +} + +.memproto .memname a { + font-weight: bold; +} +/* --- */ + +.memdoc, dl.reflist dd { + border: 0; + padding: 0; + background: none; + border-radius: 0; + box-shadow: none; + -moz-border-radius: 0; + -moz-box-shadow: none; + -webkit-border-radius: 0; + -webkit-box-shadow: none; +} + +dl.reflist dt { +} + +dl.reflist dd { +} + +.paramkey { +} + +.paramtype { +} + +.paramname { + color: #363534; +} + +.paramname em { +} + +.paramname code { +} + +.params, .retval, .exception, .tparams { +} + +.params .paramname, .retval .paramname { +} + +.params .paramtype { +} + +.params .paramdir { +} + +.mlabels { +} + +td.mlabels-left { +} + +td.mlabels-right { +} + +span.mlabels { +} + +span.mlabel { + background-color: #E6E6E6; + border: 0; + color: #66666E; + padding: 4px 5px; + border-radius: 4px; + font-size: 11px; +} + +/* @end */ + +/* these are for tree view when not used as main index */ + +div.directory { + border: none; +} + +.directory table { +} + +.directory td { +} + +.directory td.entry { +} + +.directory td.entry a { + font-weight: bold; +} + +.directory td.entry a img { +} + +.directory td.desc { + border-color: #E6E6E6; +} + +.directory tr.even { + background: none; +} + +.directory img { + vertical-align: -30%; +} + +.directory .levels { +} + +.directory .levels span { +} + +div.dynheader { +} + +address { +} + +table.doxtable { +} + +table.doxtable td, table.doxtable th { + border: 1px solid #E6E6E6; +} + +table.doxtable th { + background-color: #F6F6F6; + color: #66666E; + font-size: 13px; +} + +table.fieldtable { + padding: 5px 10px; + border: 1px solid #E6E6E6; + background-color: #F6F6F6; + box-shadow: none; + border-radius: 7px; + -moz-box-shadow: none; + -moz-border-radius: 7px; + -webkit-box-shadow: none; + -webkit-border-radius: 7px; +} + +.fieldtable td, .fieldtable th { +} + +.fieldtable td.fieldtype, .fieldtable td.fieldname { + border: 0; +} + +.fieldtable td.fieldname { + font-size: 13px; +} + +/* additional */ +.fieldtable td.fieldname em { + font-style: normal; +} +/* --- */ + +.fieldtable td.fielddoc { + border: 0; + font-size: 13px; +} + +/* additional */ +.fieldtable td.fielddoc * { + font-size: 13px; +} +/* --- */ + +.fieldtable td.fielddoc p:first-child { + margin: auto; +} + +.fieldtable td.fielddoc p:last-child { + margin: auto; +} + +.fieldtable tr:last-child td { +} + +.fieldtable th { + background: none; + background-color: #E6E6E6; + font-size: 13px; + font-weight: normal; + color: #363534; + border-radius: 0; + -moz-border-radius: 0; + -webkit-border-radius: 0; + border: 0; +} + +.tabsearch { +} + +.navpath ul { + background: none; + background-color: #E6E6E6; + color: #363534; + border: 0; + font-size: 13px; +} + +.navpath li { + color: #363534; +} + +.navpath li.navelem a { + color: #363534; +} + +.navpath li.navelem a:hover { + color: #363534; +} + +.navpath li.footer { + color: #363534; + font-size: 13px; +} + +div.summary { + margin: 20px; + width: auto; + display: inline-block; + text-align: left; + color: transparent; + line-height: 0; + padding: 15px 25px; + border: 1px solid #E6E6E6; + background-color: #F6F6F6; + border-radius: 7px; + -moz-border-radius: 7px; + -webkit-border-radius: 7px; + font-size: 13px; +} + +div.summary a { + display: block; + line-height: 1.5; +} + +div.ingroups { +} + +div.ingroups a { +} + +div.header { + background: none; + border: 0; +} + +div.headertitle { +} + +dl { +} + +/* dl.note, dl.warning, dl.attention, dl.pre, dl.post, dl.invariant, dl.deprecated, dl.todo, dl.test, dl.bug */ +dl.section { +} + +dl.note { +} + +dl.warning, dl.attention { +} + +dl.pre, dl.post, dl.invariant { +} + +dl.deprecated { +} + +dl.todo { +} + +dl.test { +} + +dl.bug { +} + +dl.section dd { +} + +#projectlogo { +} + +#projectlogo img { +} + +#projectname { + font: 24px Verdana,DejaVu Sans,Geneva,sans-serif; + font-weight: bold; + display: inline; +} + +#projectbrief { + font: 16px Verdana,DejaVu Sans,Geneva,sans-serif; + display: inline; +} + +#projectnumber { + font: 16px Verdana,DejaVu Sans,Geneva,sans-serif; + display: inline; +} + +#titlearea { + border: 0; + background-color: #E6E6E6; +} + +.image { +} + +.dotgraph { +} + +.mscgraph { +} + +.diagraph { +} + +.caption { +} + +div.zoom { +} + +dl.citelist { +} + +dl.citelist dt { +} + +dl.citelist dd { +} + +div.toc { +} + +div.toc li { +} + +div.toc h3 { +} + +div.toc ul { +} + +div.toc li.level1 { +} + +div.toc li.level2 { +} + +div.toc li.level3 { +} + +div.toc li.level4 { +} + +.inherit_header { +} + +.inherit_header td { +} + +.inherit { +} + +tr.heading h2 { +} + +/* tooltip related style info */ + +.ttc { +} + +#powerTip { +} + +#powerTip div.ttdoc { +} + +#powerTip div.ttname a { +} + +#powerTip div.ttname { +} + +#powerTip div.ttdeci { +} + +#powerTip div { + font: 13px/1.3 Verdana,DejaVu Sans,Geneva,sans-serif; + color: #363534; +} + +#powerTip:before, #powerTip:after { +} + +#powerTip.n:after, #powerTip.n:before, +#powerTip.s:after, #powerTip.s:before, +#powerTip.w:after, #powerTip.w:before, +#powerTip.e:after, #powerTip.e:before, +#powerTip.ne:after, #powerTip.ne:before, +#powerTip.se:after, #powerTip.se:before, +#powerTip.nw:after, #powerTip.nw:before, +#powerTip.sw:after, #powerTip.sw:before { +} + +#powerTip.n:after, #powerTip.s:after, +#powerTip.w:after, #powerTip.e:after, +#powerTip.nw:after, #powerTip.ne:after, +#powerTip.sw:after, #powerTip.se:after { +} + +#powerTip.n:before, #powerTip.s:before, +#powerTip.w:before, #powerTip.e:before, +#powerTip.nw:before, #powerTip.ne:before, +#powerTip.sw:before, #powerTip.se:before { +} + +#powerTip.n:after, #powerTip.n:before, +#powerTip.ne:after, #powerTip.ne:before, +#powerTip.nw:after, #powerTip.nw:before { +} + +#powerTip.n:after, #powerTip.ne:after, #powerTip.nw:after { +} +#powerTip.n:before { +} +#powerTip.n:after, #powerTip.n:before { +} + +#powerTip.nw:after, #powerTip.nw:before { +} + +#powerTip.ne:after, #powerTip.ne:before { +} + +#powerTip.s:after, #powerTip.s:before, +#powerTip.se:after, #powerTip.se:before, +#powerTip.sw:after, #powerTip.sw:before { +} + +#powerTip.s:after, #powerTip.se:after, #powerTip.sw:after { +} + +#powerTip.s:before, #powerTip.se:before, #powerTip.sw:before { +} + +#powerTip.s:after, #powerTip.s:before { +} + +#powerTip.sw:after, #powerTip.sw:before { +} + +#powerTip.se:after, #powerTip.se:before { +} + +#powerTip.e:after, #powerTip.e:before { +} + +#powerTip.e:after { +} + +#powerTip.e:before { +} + +#powerTip.w:after, #powerTip.w:before { +} + +#powerTip.w:after { +} + +#powerTip.w:before { +} + +/* tabs.css */ + +.tabs, .tabs2, .tabs3 { + background: none; + background-color: #F6F6F6; + font: 13px Verdana,DejaVu Sans,Geneva,sans-serif; + border-bottom: 1px solid #E6E6E6; +} + +.tabs2 { + font-size: 13px; +} +.tabs3 { + font-size: 13px; +} + +.tablist { +} + +.tablist li { + background: none; + line-height: 1.5; +} + +.tablist a { + padding: 0 10px; + font-weight: normal; + background: none; + color: #00732F; + text-shadow: none; +} + +.tabs3 .tablist a { +} + +.tablist a:hover { + background: none; + color: #00732F; + text-shadow: none; +} + +.tablist li.current a { + background: none; + color: #00732F; + text-shadow: none; +} + +/* navtree.css */ + +#nav-tree .children_ul { +} + +#nav-tree ul { +} + +#nav-tree li { +} + +#nav-tree .plus { +} + +#nav-tree .selected { + background: none; + background-color: #E6E6E6; + color: #00732F; + text-shadow: none; +} + +#nav-tree img { +} + +#nav-tree a { +} + +#nav-tree .label { + font: 12px Verdana,DejaVu Sans,Geneva,sans-serif; +} + +#nav-tree .label a { +} + +#nav-tree .selected a { + color: #00732F; +} + +#nav-tree .children_ul { +} + +#nav-tree .item { +} + +#nav-tree { + background-color: #F6F6F6; +} + +#doc-content { +} + +#side-nav { +} + +.ui-resizable .ui-resizable-handle { +} + +.ui-resizable-e { + background: none; + background-color: #E6E6E6; +} + +.ui-resizable-handle { +} + +#nav-tree-contents { +} + +#nav-tree { + background: none; + background-color: #F6F6F6; +} + +#nav-sync { +} + +#nav-sync img { +} + +#nav-sync img:hover { +} +