Skip to content

Commit

Permalink
Update documentation and README
Browse files Browse the repository at this point in the history
  • Loading branch information
Sven Strothoff committed Jan 18, 2013
1 parent 5c03a03 commit 1b5aee6
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 6 deletions.
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,13 +6,14 @@ Generate Doxygen comments for your C/C++ code.

You need to have libClang (Version 3.0 or higher) installed on your system for
this plugin to work.

This plugin uses Python to interface with libClang, so make sure that your Vim
version was compiled with Python support. If `:version` includes `+python` you
are good to go.
Currently this plugin requires the
[XPTemplate](https://github.com/drmingdrmer/xptemplate) plugin to be
installed. In the future this will be configurable and it will be possible to
insert basic, i.e. without place-holders, Doxygen comments without XPTemplate.

If you want to have clang doxygen generate placeholders, so that you can qickly
enter your documentation, you need one of the supported snippet plugins. See
`:help g:clang_doxygen_snippet_plugin`.

## Installation

Expand All @@ -22,8 +23,7 @@ plugin manager like [pathogen.vim](https://github.com/tpope/vim-pathogen).
## Usage

Move the cursor onto a function declaration and run `:GenerateDoxygen`. This
will parse your source file and create and insert an XPTemplate, so that you
just have to replace the place-holders with your documentation.
will parse your source file and generate and insert a Doxygen comment.

For more information see `:help clang_doxygen`.

Expand Down
10 changes: 10 additions & 0 deletions doc/clang_doxygen.txt
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,9 @@ Help on clang doxygen plugin *clang_doxygen*

The clang doxygen plugin creates Doxygen comments for C/C++ code.

Optionally clang doxygen can generate placeholders and trigger a snippet
plugin, so that you can quickly enter your documentaion.

Why another Doxygen plugin?~

While I was looking for a vim plugin to help me document my C++ source code I
Expand All @@ -43,6 +46,13 @@ the Clang development team, see |clang_doxygen-requirements|.
The C interface to the Clang compiler (libClang) is used to parse the source
code and extract information like parameter names and return type. For this
plugin libClang version 3.0 or greater must be installed on the system.
This plugin uses the Python bindings for accessing libClang, so make sure that
your version of Vim was compiled with Python support. If |:version| includes
|+python| you are good to go.

To generate placeholders and use a snippet plugin when generating Doxygen
comments, one of the supported snippet plugins has to be installed, see
|g:clang_doxygen_snippet_plugin|.

==============================================================================
3. Usage *clang_doxygen-usage*
Expand Down

0 comments on commit 1b5aee6

Please sign in to comment.