Configuration and use of Doxygen under Linux

In a large program, it is important to have a good comment on your own program, to read and maintain your program, especially when writing a package. Others recommended Doxygen to comment on the program, their own use of the next feeling is very good, recommend everyone to use.

I use the system is Ubuntu16.04, here is mainly about the system under the Doxygen installation and configuration, in other Linux systems are similar.

1. Installation of Doxygen

sudo apt-get Install Doxygen
sudo apt-get install Graphviz

Where Graphviz is a doxygen dependent package, if not installed, the use of Doxygen will be an error.

2. Doxygentoolkit.vim plug-in configuration

1) Download Doxygentoolkit.vim plugin

: http://www.vim.org/scripts/script.php?script_id=987

After you open the URL, search for Doxygentoolkit.vim, and then download it.

2) Place the downloaded file Doxygentoolkit.vim in the Vim's plugin folder

General Linux Vim's plugin folder under/usr/share/vim/vim74/plugin (I use the vim74). If you are not in this folder, search with sudo locate/plugin.

3) Modify the VIMRC file

At the end of the VIMRC file, add the following command:

Let g:doxygentoolkit_brieftag_pre="@Synopsis"Let g:doxygentoolkit_paramtag_pre="@Param"Let G:doxygentoolkit_returntag="@Returns"Let g:doxygentoolkit_blockheader="============================================================================"Let g:doxygentoolkit_blockfooter="============================================================================"Let g:doxygentoolkit_authorname="XIU"Let G:doxygentoolkit_filetag="@filename"  

Where: Doxygentoolkit_authorname= "XIU" according to their own name to modify.

3. Using the Doxygen plugin

After configuring the Doxygen, you can use Doxygen to comment on your own program, detailed use of the way to see the blog: http://blog.csdn.net/omenglishuixiang1234/article/details/51122535.

　　

Original post: http://blog.csdn.net/omenglishuixiang1234/article/details/51122535

Configuration and use of Doxygen under Linux