If the QtHelp documentation is not working for a user, regardless of the
checked option in the configuration dialog, it is not clear where to search
for the problem. Specifically, the typical problem is a not installed distro
Qt documentation package. This patch adds information where to start searching
for the solution by hinting the user to look at the path provided by "qmake -query".
Details
Details
- Reviewers
apol kfunk - Group Reviewers
KDevelop - Commits
- R32:52aba6751239: Add GUI feedback if no system QtHelp file is available
R32:9dedd546edbb: Refactor QtHelp plugin to provide a state.
R32:397fdc495e98: Make Dialog Name more General
R32:d6bc1de51d86: Use message widget for status message.
R32:0ee25ab9a67c: Add GUI feedback if no system QtHelp file is available.
R32:7f3bafa9de0a: Fix handling of all QCH files instead of only first.
Diff Detail
Diff Detail
- Repository
- R32 KDevelop
- Lint
Automatic diff as part of commit; lint not applicable. - Unit
Automatic diff as part of commit; unit tests not applicable.
| documentation/qthelp/qthelpconfig.cpp | ||
|---|---|---|
| 380 | Why the change? This doesn't specify what kind of documentation. One could have documentation on other formats. e.g. PHP docs | |
| documentation/qthelp/qthelpqtdoc.cpp | ||
| 120 ↗ | (On Diff #3731) | This loop looks weird. It will just take the first entry, is that what we want? |
| documentation/qthelp/qthelpconfig.cpp | ||
|---|---|---|
| 380 | My intention was to make clear that this is a configuration page for the API documentations one can install for different frameworks/languages. "QtHelp Documentation" is correct from the implementation details, yet a user won't care if it is in QCH files or different containers. Furthermore, I did not use "Documentation" since that easily can be confused with documentation about KDevelop. | |
| documentation/qthelp/qthelpqtdoc.cpp | ||
| 120 ↗ | (On Diff #3731) | I see your point. The logic however was already there and worked :) |
Comment Actions
Fix handling of all QCH files instead of only first.
All QCH files must be processed instead of only the first one.
This problem was covered by the internal caching of the help files
and showed only in a clean environment.
Comment Actions
Looks good to me all in all. Maybe a unit test could be introduced. That would be very welcome.
For now, let's get this in (modulo the nitpicks).
| documentation/qthelp/qthelpconfig.cpp | ||
|---|---|---|
| 380 | Maybe "Qt API Documentation"? | |
| documentation/qthelp/qthelpplugin.cpp | ||
| 165 ↗ | (On Diff #3755) | name isQtHelpAvailable (bool property naming convention). |
| documentation/qthelp/qthelpqtdoc.cpp | ||
| 124 ↗ | (On Diff #3755) | Use entryInfoList so you don't need to explicitly construct the path. |