qthelp : Allows you to open Qt help pages in browser from your C++ source code.
| script karma |
Rating 4/1,
Downloaded by 157
|
Comments, bugs, improvements
|
Vim wiki
|
| created by |
| x aizek |
| |
| script type |
| utility |
| |
| description |
This plugin would allow you to open Qt help pages in browser from your C++ source code. Currently it can show help if the word underneath your cursor is a class name, a variable name or a class-member name.
Examples:
QStr|ing trackTitle, artistName;
QString track|Title, artistName("Unknown");
track|Title = "Unknown";
Running command :QHelpOnThis will open help on QString.
trackTitle.ri|ght(10);
Running command :QHelpOnThis will open help on QString::right.
Running command :QHelp QPixmap::QPixmap will open help on
QPixmap constructor.
Configuring:
g:qthelp_browser - command to run your browser
default: '' (so an error message will be printed if your try to use plugin)
Note: on Windows use something like (notice 'start' at the beginning)
'start c:\\Program files\\Mozilla Firefox\\firefox.exe'
or Vim will be waiting until you close your browser.
Using:
1. Make tags-file for your html-qthelp.
2. Add that tags-file into your 'tags' option (WARNING: doing this in your .vimrc file can slow down and pollute completion list for not Qt-projects).
3. Setup g:qthelp_browser variable with the command to run your browser.
4. Map command QHelpOnThis on some hotkey.
5. Use QHelp from command-line for faster navigating through help (to escape manual searching of needed section).
Limitation:
I didn't found a way to determine inheritance hierarchy using tags so trying
QStringList strlst;
strlst.in|sert("String");
will open reference for QString, not for QList::insert.
Warning:
In some cases it can take a while for searching definition (for example when it doesn't exist) if this happens hit Ctrl-C to break searching.
Advice:
You may be interesting in inccomplete (vimscript #3345) plugin, that can help to find header file you need.
You could always find the latest version on github: http://github.com/xaizek/vim-qthelp
Feel free to contact me if you have any question or suggestions. |
| |
| install details |
| Just extract the archive into your ~/.vim/ or ~/vimfiles/ (~/.vim/bundle/ or ~/vimfiles/bundle/ if you use Pathogen (vimscript #2332)). |
| |
script versions (upload new version)
Click on the package to download.
ip used for rating: 50.17.109.248
|