Mercurial > vim
comparison runtime/doc/syntax.txt @ 832:c76f780d4e05
updated for version 7.0d05
| author | vimboss |
|---|---|
| date | Sat, 15 Apr 2006 20:27:24 +0000 |
| parents | dc8197342755 |
| children | 5117153003bd |
comparison
equal
deleted
inserted
replaced
| 831:f24a95dae8ee | 832:c76f780d4e05 |
|---|---|
| 1 *syntax.txt* For Vim version 7.0d. Last change: 2006 Apr 14 | 1 *syntax.txt* For Vim version 7.0d. Last change: 2006 Apr 15 |
| 2 | 2 |
| 3 | 3 |
| 4 VIM REFERENCE MANUAL by Bram Moolenaar | 4 VIM REFERENCE MANUAL by Bram Moolenaar |
| 5 | 5 |
| 6 | 6 |
| 853 | 853 |
| 854 :let g:dosbatch_syntax_for_btm = 1 | 854 :let g:dosbatch_syntax_for_btm = 1 |
| 855 | 855 |
| 856 If this variable is undefined or zero, btm syntax is selected. | 856 If this variable is undefined or zero, btm syntax is selected. |
| 857 | 857 |
| 858 | |
| 859 DOXYGEN *doxygen.vim* *doxygen-syntax* | |
| 860 | |
| 861 Doxygen generates code documentation using a special documentation format | |
| 862 (similar to Javadoc). This syntax script adds doxygen highlighting to c, cpp | |
| 863 and idl files, and should also work with java. | |
| 864 | |
| 865 There are a few of ways to turn on doxygen formatting. It can be done explicity | |
| 866 or in a modeline by appending '.doxygen' to the syntax of the file. Example: > | |
| 867 :set syntax=c.doxygen | |
| 868 or > | |
| 869 // vim:syntax=c.doxygen | |
| 870 | |
| 871 To use doxygen formatting on top of any filetype, add the following to your | |
| 872 .vimrc for each filetype, replacing {filetype} with the relevent value. > | |
| 873 :let g:syntax_extra_{filetype}='doxygen' | |
| 874 | |
| 875 It can also be done automaticly for c, cpp and idl files by setting the global | |
| 876 or buffer-local variable load_doxygen_syntax. This is done by adding the | |
| 877 following to your .vimrc. > | |
| 878 :let g:load_doxygen_syntax=1 | |
| 879 | |
| 880 There are a couple of variables that have an affect on syntax highlighting, and | |
| 881 are to do with non-standard highlighting options. | |
| 882 | |
| 883 Variable Default Effect ~ | |
| 884 g:doxygen_enhanced_color | |
| 885 g:doxygen_enhanced_colour 0 Use non-standard highlighting for | |
| 886 doxygen comments. | |
| 887 | |
| 888 doxygen_my_rendering 0 Disable rendering of HTML bold, italic | |
| 889 and html_my_rendering underline. | |
| 890 | |
| 891 doxygen_javadoc_autobrief 1 Set to 0 to disable javadoc autobrief | |
| 892 colour highlighting. | |
| 893 | |
| 894 doxygen_end_punctuation '[.]' Set to regexp match for the ending | |
| 895 punctuation of brief | |
| 896 | |
| 897 There are also some hilight groups worth mentioning as they can be useful in | |
| 898 configuration. | |
| 899 | |
| 900 Highlight Effect ~ | |
| 901 doxygenErrorComment The colour of an end-comment when missing | |
| 902 punctuation in a code, verbatim or dot section | |
| 903 doxygenLinkError The colour of an end-comment when missing the | |
| 904 \endlink from a \link section. | |
| 858 | 905 |
| 859 | 906 |
| 860 DTD *dtd.vim* *ft-dtd-syntax* | 907 DTD *dtd.vim* *ft-dtd-syntax* |
| 861 | 908 |
| 862 The DTD syntax highlighting is case sensitive by default. To disable | 909 The DTD syntax highlighting is case sensitive by default. To disable |