CND69Doxygen

Revision as of 21:46, 17 February 2010 by Thp (Talk | contribs)

Contents

CND 69 Doxygen

Doxygen is a tool to convert your C++ comments into publishable HTML. It works by extracting commentary directly from the source with the help of a special Doxygen syntax.

Team

  • Dev: Thomas Preisler
  • Lead: Vladimir Voskresensky

Overview

  1. Use Doxygen generated html documentation in editors code completion.

Target User

Anyone using C/C++ editor and code completion.

Typical Workflow

  1. User installs Doxygen and possible also configures CND to know about Doxygen (Tools/Options/C/C++...)
  2. User adds Doxygen commands to source files. Either manual or using generated template.
  3. Code completion now shows proper documentation for classes, methods, etc. when invoked

User View

Doxygen Code Templates

Support commen Doxygen templates for easily adding Doxygen command to source files (see https://netbeans.org/bugzilla/show_bug.cgi?id=171326):

Before template expansion:

/**|*/
double abs(complex& a){ // magnitude of the complex number
    return sqrt(a.real*a.real + a.img*a.img);
}

After template expansion

/**
 *
 * @param a
 * @return
 */
double abs(complex& a){ // magnitude of the complex number
    return sqrt(a.real*a.real + a.img*a.img);
}


Integration with Code Completion

Integrate html Doxygen docs with code completion. Code completion will automatically pick up the generated html documentation and present it in the code completion pop-up choice dialog.

File:codecompletion.jpg

Resources

IZ:

https://netbeans.org/bugzilla/show_bug.cgi?id=178882

Tutorial:

http://www.stack.nl/~dimitri/doxygen/starting.html

http://www-scf.usc.edu/~peterchd/doxygen/

http://class.ee.iastate.edu/cpre288/lectures_files/Doxygen%20Tutorial.pdf

Project:

http://sourceforge.net/projects/doxygen/

http://www.doxygen.org

http://www.stack.nl/~dimitri/doxygen/

Latest sources:

http://www.stack.nl/~dimitri/doxygen/download.html#latestsrc

I have started experimenting with documentation in C/C++ code completion. The code is in the pelmel project: http://kenai.com/projects/pelmel in the NB6.8 repository: http://kenai.com/projects/pelmel/sources/nb68/show in module "cnd"/"Extended C/C++ Editor". The module can be installed from this update center: http://lahoda.info/hudson/job/pelmel68/lastSuccessfulBuild/artifact/build/updates/updates.xml.gz Note that the module requires a very recent trunk build.

Schedule

Milestone Date Content
1 1/18/10 User View Ready
2 3/15/10 Feature useful
3 NB 6.9 M1 4/07/10
4 NB 6.9 Beta 4/15/10 Feature complete
5 NB 6.9 Code Freeze 5/10/10 Done, all P1/2 bugs fixed.
Not logged in. Log in, Register

By use of this website, you agree to the NetBeans Policies and Terms of Use. © 2012, Oracle Corporation and/or its affiliates. Sponsored by Oracle logo