doxygen


Ⅰ. 插件描述

Official doxygen git repository

Ⅱ. 基本信息

创建日期:  2013-05-19
使用用户:  1
Github星:  2864
插件作者:  Dimitri van Heesch

Ⅲ. 安装方法

使用Vundle管理器安装

在你的.vimrc下添加:
Plugin 'doxygen/doxygen-long-live'
… 然后在Vim中运行以下命令:
:source %
:PluginInstall

对于Vundle版本 < 0.10.2,请用上面的Bundle替换Plugin。

使用NeoBundle管理器安装

在你的.vimrc下添加:
NeoBundle 'doxygen/doxygen-long-live'
… 然后在Vim中运行以下命令:
:source %
:NeoBundleInstall

使用VimPlug管理器安装

在你的.vimrc下添加:
Plug 'doxygen/doxygen-long-live'
… 然后在Vim中运行以下命令:
:source %
:PlugInstall

使用Pathogen管理器安装

在终端中运行以下命令:
cd ~/.vim/bundle
git clone https://github.com/doxygen/doxygen

Ⅳ. 文档说明

Doxygen

Donate

Doxygen is the de facto standard tool for generating documentation from
annotated C++ sources, but it also supports other popular programming
languages such as C, Objective-C, C#, PHP, Java, Python, IDL
(Corba, Microsoft, and UNO/OpenOffice flavors), Fortran, VHDL, Tcl,
and to some extent D.

Doxygen can help you in three ways:

  1. It can generate an on-line documentation browser (in HTML) and/or an
    off-line reference manual (in LaTeX) from a set of documented source files.

There is also support for generating output in RTF (MS-Word), PostScript,
hyperlinked PDF, compressed HTML, DocBook and Unix man pages.
The documentation is extracted directly from the sources, which makes
it much easier to keep the documentation consistent with the source code.

  1. You can configure doxygen to extract the code structure from undocumented
    source files. This is very useful to quickly find your way in large

source distributions. Doxygen can also visualize the relations between
the various elements by means of include dependency graphs, inheritance
diagrams, and collaboration diagrams, which are all generated automatically.

  1. You can also use doxygen for creating normal documentation (as I did for
    the doxygen user manual and doxygen web-site).

Download

The latest binaries and source of Doxygen can be downloaded from:

Developers

Issues, bugs, requests, ideas

Use the issue tracker to report bugs.

Comms

Mailing Lists

There are three mailing lists:

  • doxygen-announce@lists.sourceforge.net - Announcement of new releases only
  • doxygen-users@lists.sourceforge.net - for doxygen users
  • doxygen-develop@lists.sourceforge.net - for doxygen developers
  • To subscribe follow the link to

Source Code

In May 2013, Doxygen moved from
subversion to git hosted at GitHub

Enjoy,

Dimitri van Heesch (doxygen at gmail.com)

添加新评论