Welcome! Log In Create A New Profile

Syntax for documenting code

Announcements		Last Post
	SoC Curricula	09/30/2017 01:08PM
	Demarcation or scoping of examinations and assessment	02/13/2017 07:59AM
	School of Computing Short Learning Programmes	11/24/2014 08:37AM
	Unisa contact information	07/28/2011 01:28PM

Forums Messages New

Marthinus Engelbrecht

Syntax for documenting code
July 01, 2010 11:42AM

Registered: 15 years ago
Posts: 84
Rating: 0

Hey guys, just trying to get an idea of which syntax is the best to use when documenting classes and method. I'm using the Javadoc style @param @return etc...but I'm thinking there has to be some tool for generating documentation for C++ code (and in this case C++ with Qt), with its own syntax.

Reply Quote

robanaurochs

Re: Syntax for documenting code
July 01, 2010 12:06PM

Registered: 18 years ago
Posts: 1,424
Rating: 0

The documentation displayable in Qt Assistant was generated from the source code using doxygen

Reply Quote

Marthinus Engelbrecht

Re: Syntax for documenting code
July 01, 2010 02:40PM

Registered: 15 years ago
Posts: 84
Rating: 0

Thanks, downloaded it and checked it out. Works quite nice and it makes provision for more C++ specific stuff too, like a typedef tag while still allow you to use @ sign before it like other javadoc tags. Plus you can still use the javadoc basic tags like @return.