doxygen/doxygen-qmi-style/README.md


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
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)