Skip to content

Commit

Permalink
Add documentation.
Browse files Browse the repository at this point in the history
  • Loading branch information
xavierd committed Mar 4, 2013
1 parent cdf98a5 commit ca69d7a
Showing 1 changed file with 29 additions and 18 deletions.
47 changes: 29 additions & 18 deletions doc/clang_complete.txt
Original file line number Diff line number Diff line change
Expand Up @@ -7,15 +7,16 @@
clang_complete plugin *clang_complete*

1. Description |clang_complete-description|
2. Completion kinds |clang_complete-compl_kinds|
3. Configuration |clang_complete-configuration|
4. Options |clang_complete-options|
5. Known issues |clang_complete-issues|
6. PCH |clang_complete-pch|
7. cc_args.py script |clang_complete-cc_args|
8. To do |clang_complete-todo|
9. FAQ |clang_complete-faq|
10. License |clang_complete-license|
2. Key bindings |clang_complete-keybindings|
3. Completion kinds |clang_complete-compl_kinds|
4. Configuration |clang_complete-configuration|
5. Options |clang_complete-options|
6. Known issues |clang_complete-issues|
7. PCH |clang_complete-pch|
8. cc_args.py script |clang_complete-cc_args|
9. To do |clang_complete-todo|
10. FAQ |clang_complete-faq|
11. License |clang_complete-license|

Author: Xavier Deguillard <deguilx@gmail.com> *clang_complete-author*

Expand All @@ -29,7 +30,17 @@ unconditionnaly set mapping done by omnicppcomplete. So don't forget to
suppress it before using this plugin.

==============================================================================
2. Completion kinds *clang_complete-compl_kinds*
2. Key bindings *clang_complete-keybindings*

Completion is started with CTRL-X CTRL-U |i_CTRL-X_CTRL-U|, or automatically
depending on the value of |clang_complete-auto|.

You can also jump to the declaration of the symbol under the cursor with
<CTRL-]>. Jumping back is done with <CTRL-T>. Since clang_complete uses
|jumplist|, you can navigate through the jumps with <CTRL-O> and <CTRL-I>

==============================================================================
3. Completion kinds *clang_complete-compl_kinds*

Because libclang provides a lot of information about completion, there are
some additional kinds of completion along with standard ones (see
Expand All @@ -43,7 +54,7 @@ some additional kinds of completion along with standard ones (see
'p' - template ('p' from "pattern")

==============================================================================
3. Configuration *clang_complete-configuration*
4. Configuration *clang_complete-configuration*

Each project can have a .clang_complete at his root, containing the compiler
options. This is useful if you're using some non-standard include paths or
Expand Down Expand Up @@ -73,7 +84,7 @@ Example .clang_complete file: >
-I/usr/include/c++/4.5.3/x86_64-slackware-linux/
<
==============================================================================
4. Options *clang_complete-options*
5. Options *clang_complete-options*

*clang_complete-auto_select*
*g:clang_auto_select*
Expand Down Expand Up @@ -237,7 +248,7 @@ If clang should complete code patterns, i.e loop constructs etc.
Defaut: 0

==============================================================================
5. Known issues *clang_complete-issues*
6. Known issues *clang_complete-issues*

If you find that completion is slow, please read the |clang_complete-pch|
section below.
Expand All @@ -256,7 +267,7 @@ public ones. Which means that I cannot filter private methods on the
completion list.

==============================================================================
6. PCH *clang_complete-pch*
7. PCH *clang_complete-pch*

In case you can not or you do not want to install libclang, a precompiled
header file is another way to accelerate compilation, and so, to accelerate
Expand All @@ -279,7 +290,7 @@ header and then compile it to pch: >
And then add it to the .clang_complete file.

==============================================================================
7. cc_args.py script *clang_complete-cc_args*
8. cc_args.py script *clang_complete-cc_args*

This script, installed at ~/.vim/bin/cc_args.py, could be used to generate or
update the .clang_complete file. It works similar to gccsence's gccrec and
Expand All @@ -295,7 +306,7 @@ new options. If you don't want to update an existing configuration file,
delete it before running make.

==============================================================================
8. To do *clang_complete-todo*
9. To do *clang_complete-todo*

- Write some unit tests
- clang vs libclang accuracy for complex completions
Expand All @@ -305,7 +316,7 @@ delete it before running make.
- Parse fix-its and do something useful with it

==============================================================================
9. FAQ *clang_complete-faq*
10. FAQ *clang_complete-faq*

*) clang_complete doesn't work! I always get the message "pattern not found".

Expand Down Expand Up @@ -342,7 +353,7 @@ adding the following line to your vimrc:
set completeopt=menu,longest

==============================================================================
10. License *clang_complete-license*
11. License *clang_complete-license*

Copyright (c) 2010, 2011, Xavier Deguillard
All rights reserved.
Expand Down

0 comments on commit ca69d7a

Please sign in to comment.