Skip to content

Latest commit

 

History

History
30 lines (25 loc) · 935 Bytes

README.md

File metadata and controls

30 lines (25 loc) · 935 Bytes

AutoDoxyDoc

Generates Qt/JavaDoc style documentation comments for C++ when /// or /*! is typed.

This is a fork of https://github.com/dragospop/CppDoxyComplete.

Supports the following format:

/*!
 *  comment
 *
 *      @param param_name direction comment
 *
 *      @return comment
 *
 *      @remarks
 *      ...
 */

Supports also smart updating of existing comments using Ctrl+Shift+D. Smart updating can preserve existing comments but also add/remove parameter comments based on the changes done to the function parameters.

AutoDoxyDoc also supports some customizations:

  • Tag indentation level
  • Tag style (JavaDoc or Qt)
  • Smart comments: Autogeneration of comments based on the function information
  • Abbreviations: Ability to unabbreviate word for smart comments

Icons made by Vitaly Gorbachev from www.flaticon.com.