Merge lp:~josephjamesmills/ubuntu-ui-toolkit/QtCreator_Help_Plugins into lp:ubuntu-ui-toolkit

Proposed by Joseph Mills on 2013-04-29
Status: Rejected
Rejected by: Zoltan Balogh on 2013-05-04
Proposed branch: lp:~josephjamesmills/ubuntu-ui-toolkit/QtCreator_Help_Plugins
Merge into: lp:ubuntu-ui-toolkit
Diff against target: 95 lines (+52/-17)
3 files modified
debian/changelog (+7/-0)
documentation/ubuntu-ui-toolkit-common.qdocconf (+41/-12)
documentation/ubuntu-ui-toolkit-offline.qdocconf (+4/-5)
To merge this branch: bzr merge lp:~josephjamesmills/ubuntu-ui-toolkit/QtCreator_Help_Plugins
Reviewer Review Type Date Requested Status
Juhapekka Piiroinen (community) Disapprove on 2013-05-02
Zoltan Balogh (community) 2013-04-29 Needs Information on 2013-05-01
Review via email: mp+161353@code.launchpad.net

Description of the change

* documentation/ubuntu-ui-toolkit-common.qdocconf: intergrate qtcreator
  includes offline No CSS qdocconf to use

  cd documentation/
  qdoc ubuntu-ui-toolkit-common.qdocconf
  cd html
  qhelpgenerator ubuntuuitoolkit.qhp -o ubuntu-ui-toolkit.qch

watch the C++ errors happen then open qtcreator go to

  Tools --> Options --> Help --> Documentation --> add
  add the qch file. Or just install to the correct path on machine.

* documentation/ubuntu-ui-toolkit-offline.qdocconf:set css path
  Css paths where wrong that is all.

To post a comment you must log in.
Zoltan Balogh (bzoltan) wrote :

1. Why the project name is changed?
2. Why the headerdirs is removed?
3. We do not need the *.mm for now
4. Why headers.fileextensions is removed?
5. What difference is between outputdir += html and outputdir = html?
6. Why yntaxhighlighting = true, sourceencoding = UTF-8, outputencoding = UTF-8 are removed
7. Wht the documentation is removed from HTML.stylesheets

review: Needs Information
Joseph Mills (josephjamesmills) wrote :

Hey Zoltan
1) project name change. I am not sure what this means
2) header dirs are still there (or so I though)
3) you are correct
4) there is no need for that
5) You can add a extension to the filter using '+='.
6) sure they could all be added I just did not know if this was going to be looked at I have some other Ideas also about example file and what not a great place to look at something like this would be qtmultimedia qdocconf file.
7) Not sure what this means I will chat about it on Irc.

I made a new MR which makes less changes and which supersedes this one. Thank you for your MR.
https://code.launchpad.net/~juhapekka-piiroinen/ubuntu-ui-toolkit/generate-docs-for-qtcreator/+merge/162231

review: Disapprove

Unmerged revisions

459. By Joseph Mills <> on 2013-04-29

documentation/ubuntu-ui-toolkit-common.qdocconf: intergrate qtcreator (LP: #1174116)
Adding bug number to branch

458. By Joseph Mills <> on 2013-04-29

* documentation/ubuntu-ui-toolkit-common.qdocconf: intergrate qtcreator
  includes offline No CSS qdocconf to use
  cd $SRC/documentation/
  qdoc ubuntu-ui-toolkit-common.qdocconf
  cd html
  qhelpgenerator ubuntuuitoolkit.qhp -o ubuntu-ui-toolkit.qch
  watch the C++ errors happen then open qtcreator go to
  Tools --> Options --> Help --> Documentation --> add
  add the qch file. Or just install to the correct path on machine.

* documentation/ubuntu-ui-toolkit-offline.qdocconf:set css path
  Css paths where wrong that is all.

Preview Diff

[H/L] Next/Prev Comment, [J/K] Next/Prev File, [N/P] Next/Prev Hunk
1=== modified file 'debian/changelog'
2--- debian/changelog 2013-04-26 20:32:05 +0000
3+++ debian/changelog 2013-04-29 00:55:30 +0000
4@@ -1,3 +1,10 @@
5+ubuntu-ui-toolkit (0.1.46ubuntu1) raring; urgency=low
6+
7+ * documentation/ubuntu-ui-toolkit-common.qdocconf: intergrate qtcreator (LP: #1174116)
8+ * documentation/ubuntu-ui-toolkit-offline.qdocconf:set css path
9+
10+ -- Joseph Mills <josephjamesmills@gmail.com> Sun, 28 Apr 2013 20:45:49 -0400
11+
12 ubuntu-ui-toolkit (0.1.46) raring; urgency=low
13
14 * New release
15
16=== modified file 'documentation/ubuntu-ui-toolkit-common.qdocconf'
17--- documentation/ubuntu-ui-toolkit-common.qdocconf 2013-03-09 18:50:00 +0000
18+++ documentation/ubuntu-ui-toolkit-common.qdocconf 2013-04-29 00:55:30 +0000
19@@ -1,16 +1,45 @@
20-project = Ubuntu User Interface Toolkit
21-description = Ubuntu User Interface Toolkit Documentation
22-sourcedirs = ../modules/Ubuntu/Components
23-headerdirs = ../modules/Ubuntu/Components/plugin
24-sources.fileextensions = "*.qml *.qdoc *.cpp"
25-headers.fileextensions = "*.h"
26-outputdir = html
27-outputformats = HTML
28-version = 0.1
29-syntaxhighlighting = true
30-sourceencoding = UTF-8
31-outputencoding = UTF-8
32+project = UbuntuUIToolkit
33+description = Ubuntu User Interface Toolkit Documentation
34+url = http://developer.ubuntu.com/api/ubuntu-12.10/qml/mobile/overview-ubuntu-sdk.html
35+version = 1
36+
37+# The following parameters are for creating a qhp file, the qhelpgenerator
38+# program can convert the qhp file into a qch file which can be opened in
39+# Qt Assistant and/or Qt Creator.
40+# Defines the name of the project. You cannot use operators (+, =, -) in
41+# the name. Properties for this project are set using a qhp.<projectname>.property
42+# format.
43+
44+qhp.projects = UbuntuUIToolkit
45+qhp.UbuntuUIToolkit.file = ubuntuuitoolkit.qhp
46+qhp.UbuntuUIToolkit.namespace = com.canonical.ubuntuuitoolkit.1
47+qhp.UbuntuUIToolkit.indexTitle = Ubuntu SDK
48+qhp.UbuntuUIToolkit.virtualFolder = ubuntu
49+
50+# For listing child nodes in Qt Creator or Assistant.
51+qhp.UbuntuUIToolkit.subprojects = classes qmltypes
52+qhp.UbuntuUIToolkit.subprojects.classes.title = C++ Classes
53+qhp.UbuntuUIToolkit.subprojects.classes.indexTitle = Ubuntu UI Toolkit C++ Classes
54+qhp.UbuntuUIToolkit.subprojects.classes.selectors = class fake:headerfile
55+qhp.UbuntuUIToolkit.subprojects.classes.sortPages = true
56+qhp.UbuntuUIToolkit.subprojects.qmltypes.title = QML Types
57+qhp.UbuntuUIToolkit.subprojects.qmltypes.indexTitle = Ubuntu UI Toolkit Item QML Types
58+qhp.UbuntuUIToolkit.subprojects.qmltypes.selectors = fake:qmlclass
59+qhp.UbuntuUIToolkit.subprojects.qmltypes.sortPages = true
60+
61+outputdir += html
62+
63+outputformats += HTML
64+
65+sourcedirs += ../modules/Ubuntu/Components
66+
67+sources.fileextensions += "*.cpp *.qdoc *.mm *.qml"
68
69 HTML.templatedir = .
70+
71 HTML.nobreadcrumbs = "true"
72+
73 HTML.endheader = "</head>\n"
74+
75+depends += qtcore qtdoc qtquick qtqml qtscript qtgui
76+
77
78=== modified file 'documentation/ubuntu-ui-toolkit-offline.qdocconf'
79--- documentation/ubuntu-ui-toolkit-offline.qdocconf 2013-04-09 16:16:35 +0000
80+++ documentation/ubuntu-ui-toolkit-offline.qdocconf 2013-04-29 00:55:30 +0000
81@@ -1,10 +1,9 @@
82 include(ubuntu-ui-toolkit-common.qdocconf)
83
84-HTML.stylesheets = \
85- documentation/css/reset.css \
86- documentation/css/qtquick.css \
87- documentation/css/base.css \
88- documentation/css/scratch.css
89+HTML.stylesheets = css/reset.css \
90+ css/qtquick.css \
91+ css/base.css \
92+ css/scratch.css
93
94 HTML.headerstyles = \
95 "<link rel=\"stylesheet\" type=\"text/css\" href=\"style/reset.css\" />\n" \

Subscribers

People subscribed via source and target branches

to status/vote changes: