gryf/tagbar
1
0
Fork 0
mirror of https://github.com/gryf/tagbar.git synced 2025-12-17 11:30:28 +01:00
Code Issues Projects Releases Wiki Activity

Expand manual

Browse Source
This commit is contained in:
Jan Larres
2011-02-15 19:17:46 +13:00
parent 05eb38a018
commit efe0cb3fdb
1 changed files with 65 additions and 26 deletions
Download Patch File Download Diff File Expand all files Collapse all files

91
doc/tagbar.txt
View File

@@ -7,16 +7,18 @@ Licence: Vim licence, see |license|
*tagbar* *tagbar-contents*
Contents~
1. Intro...............................*tagbar-intro*
2. Requirements........................*tagbar-requirements*
3. Installation........................*tagbar-installation*
4. Usage...............................*tagbar-usage*
5. Commands............................*tagbar-commands*
6. Configuration.......................*tagbar-configuration*
7. Adding your own file types..........*tagbar-add-types*
8. Bugs and limitations................*tagbar-bugs*
9. History.............................*tagbar-history*
10. Todo................................*tagbar-todo*
1. Intro ........................... |tagbar-intro|
Pseudo-tags ..................... |tagbar-pseudotags|
Supported features .............. |tagbar-features|
2. Requirements .................... |tagbar-requirements|
3. Installation .................... |tagbar-installation|
4. Usage ........................... |tagbar-usage|
5. Commands ........................ |tagbar-commands|
6. Configuration ................... |tagbar-configuration|
7. Adding your own file types ...... |tagbar-add-types|
8. Bugs and limitations ............ |tagbar-bugs|
9. History ......................... |tagbar-history|
10. Todo ............................ |tagbar-todo|
==============================================================================
*tagbar-intro*
@@ -54,33 +56,70 @@ Then Tagbar would display the tag information like so:
This example shows several important points. First, the tags are listed
indented below the scope they are defined in. Second, the type of a scope is
listed after its name and a colon. Third, tags for which the access/visibility
information is known are prefixed with a symbol indicating that. Fourth, it
introduces 'pseudo-tags'. Pseudo-tags are tags that are not explicitly defined
in the file but have children in it. In this example the namespace doesn't
have a name and thus ctags doesn't generate a tag for it, but since it has
children in the file it still needs to be displayed using an auto-generated
name. Pseudo-tags are denoted with an asterisk ('*') at the end of their name.
information is known are prefixed with a symbol indicating that.
*tagbar-pseudotags*
Pseudo-tags~
Another important thing the example introduces are "pseudo-tags". Pseudo-tags
are tags that are not explicitly defined in the file but have children in it.
In this example the namespace doesn't have a name and thus ctags doesn't
generate a tag for it, but since it has children it still needs to be
displayed using an auto-generated name.
Another case where pseudo-tags appear is in C++ implementation files. Since
classes are usually defined in a header file but the member methods and
variables in the implementation file the class itself won't generate a tag
in that file.
Pseudo-tags are denoted with an asterisk ('*') at the end of their name.
*tagbar-features*
Supported features~
The following features are supported by Tagbar:
* Display tags under their correct scope.
* Automatically update the tags when switching between buffers and
- Display tags under their correct scope.
- Automatically update the tags when switching between buffers and
editing files.
* Display visibility information of tags if available.
* Highlight the tag near the cursor while editing files.
* Jump to a tag from the Tagbar window.
* Display the complete prototype of a tag.
* Tags can be sorted either by name or order of appearance in the file.
* Scopes can be folded to hide uninteresting information.
* Supports all of the languages that ctags does, i.e. Ant, Assembler, ASP,
- Display visibility information of tags if available.
- Highlight the tag near the cursor while editing files.
- Jump to a tag from the Tagbar window.
- Display the complete prototype of a tag.
- Tags can be sorted either by name or order of appearance in the file.
- Scopes can be folded to hide uninteresting information.
- Supports all of the languages that ctags does, i.e. Ant, Assembler, ASP,
Awk, Basic, BETA, C, C++, C#, COBOL, DosBatch, Eiffel, Erlang, Flex,
Fortran, HTML, Java, JavaScript, Lisp, Lua, Make, MatLab, OCaml, Pascal,
Perl, PHP, Python, REXX, Ruby, Scheme, Shell script, SLang, SML, SQL,
Tcl, Tex, Vera, Verilog, VHDL, Vim and YACC.
* Can be extended to support arbitrary new types.
- Can be extended to support arbitrary new types.
==============================================================================
*tagbar-requirements*
2. Requirements~
The following requirements have to be met in order to be able to use tagbar:
- Vim 7.0 or higher. Older versions will not work since Tagbar uses data
structures that were only introduced in Vim 7.
- Exuberant ctags 5.0 or higher. Ctags is the program that generates the
tag information that Tagbar uses. It is shipped with most Linux
distributions, otherwise it can be downloaded from the following
website:
>
http://ctags.sourceforge.net/
<
Tagbar will work on any platform that ctags runs on -- this includes
UNIX derivatives, Mac OS X and Windows. Note that other versions like
GNU ctags will not work.
Tagbar generates the tag information by itself and doesn't need already
existing tag files.
- File type detection must be turned on in vim. This can be done with the
following command in your vimrc:
>
filetype on
<
See |filetype| for more information.
- Tagbar will not work in |restricted-mode|.
caveats: