Skip to content

Commit

Permalink
SDK|Documentation: Generate a .qch help file for the SDK
Browse files Browse the repository at this point in the history
API documentation inside Qt Creator for all the Doomsday libraries.
  • Loading branch information
skyjake committed Apr 15, 2014
1 parent 20f59c7 commit 029b287
Show file tree
Hide file tree
Showing 4 changed files with 1,268 additions and 0 deletions.
2 changes: 2 additions & 0 deletions doomsday/apidoc/.gitignore
Expand Up @@ -8,3 +8,5 @@ shell
gui
appfw
sdk
qch

14 changes: 14 additions & 0 deletions doomsday/build/scripts/qhelp.py
@@ -0,0 +1,14 @@
#!/usr/bin/env python
# Assumes qhelpgenerator is on the path (part of Qt)
import re, sys, os, string

print 'Patching index.qhp...'
input = file(sys.argv[1], 'rt').read()

# Doxygen writes a spurious </section> tag for some reason.
output = re.sub('</section>\s+<section title="Namespace Members"', '<!-- patched -->\n<section title="Namespace Members"', input)

# Rewrite the source file.
file(sys.argv[1], 'wt').write(output)

os.system('qhelpgenerator ' + string.join(sys.argv[1:], ' '))

0 comments on commit 029b287

Please sign in to comment.