Skip to content
This repository has been archived by the owner on Sep 21, 2020. It is now read-only.

Commit

Permalink
Update for Doxygen 1.8.8
Browse files Browse the repository at this point in the history
  • Loading branch information
agateau committed Dec 1, 2014
1 parent 0671527 commit f1a8c3b
Show file tree
Hide file tree
Showing 3 changed files with 16 additions and 9 deletions.
1 change: 1 addition & 0 deletions .gitignore
@@ -1,4 +1,5 @@
tests/manual/html
tests/manual/doxygen_sqlite3.db
*.pyc
MANIFEST
dist
Expand Down
22 changes: 14 additions & 8 deletions README.md
Expand Up @@ -15,19 +15,25 @@ or manually with:

# Telling Doxygen to use Doxyqml

Edit your Doxygen file: first you need to set the `FILTER_PATTERNS` key to
associate .qml files with Doxyqml:
To tell Doxygen about Doxyqml you must make a few changes to your Doxygen file.

FILTER_PATTERNS = *.qml=doxyqml
1. Add the .qml extension to the `FILTER_PATTERNS` key:

Note: On Windows you may need to use the full path of the `doxyqml.py` file
instead. For example if you installed Python 2.7 in `C:\Python27`, use this:
FILTER_PATTERNS = *.qml=doxyqml

FILTER_PATTERNS = *.qml=C:\Python27\Lib\site-packages\doxyqml\doxyqml.py
Note: On Windows you may need to use the full path of the `doxyqml.py` file
instead. For example if you installed Python 2.7 in `C:\Python27`, use this:

Then you must add .qml files to `FILE_PATTERNS`:
FILTER_PATTERNS = *.qml=C:\Python27\Lib\site-packages\doxyqml\doxyqml.py

FILE_PATTERNS = *.qml
2. Add the .qml extension to `FILE_PATTERNS`:

FILE_PATTERNS = *.qml

3. Since Doxygen 1.8.8, you must also add the .qml extension to
`EXTENSION_MAPPING`:

EXTENSION_MAPPING = qml=C++

# Documenting types

Expand Down
2 changes: 1 addition & 1 deletion tests/manual/Doxyfile
Expand Up @@ -32,7 +32,7 @@ OPTIMIZE_OUTPUT_FOR_C = NO
OPTIMIZE_OUTPUT_JAVA = NO
OPTIMIZE_FOR_FORTRAN = NO
OPTIMIZE_OUTPUT_VHDL = NO
EXTENSION_MAPPING =
EXTENSION_MAPPING = qml=C++
MARKDOWN_SUPPORT = YES
BUILTIN_STL_SUPPORT = NO
CPP_CLI_SUPPORT = NO
Expand Down

0 comments on commit f1a8c3b

Please sign in to comment.