Hi, Currently I'm writing a non-developer documentation for an EBU open project using GTK/GTKmm and next week I must improve the developer's documentation. I can add more rules in my doxygen configuration file and send it next week. But we should define together (GTKmm community) which are the important criterias to increase the quality of the documentation. Maybe several Doxygen's conventions will be required in the GTKmm's source. My doxygen file generates a documentation very similar to GTKmm Class Reference but with the Doxygen CSS template. But it includes in plus : UML representation of my classes and data models. UML schematics for Calls and Callers of each function. Functions can be sorted alphabetically or displayed in the same order than in my source code... so when I write a class, I organize my declarations in consequence. Find as attachment my doxygen configuration file; It's based on an official example. Regards Marco Dos Santos Oliveira EBU/European Broadcasting Union Technology and Innovation Department -----Original Message----- From: Murray Cumming [mailto:murrayc murrayc com] Sent: jeudi 31 janvier 2013 16:19 To: Dos Santos, Oliveira Cc: 'Jiergir Ogoerg'; gtkmm-list gnome org Subject: Re: Gtkmm documentation quality On Thu, 2013-01-31 at 11:29 +0100, Dos Santos, Oliveira wrote: > The documentation seems to be generated with Doxygen based on the > current CSS template of the GTKmm Class Reference. You can built a > Doxygen configuration file in which you define how to display the > information, which informations are displayed or which files is used > as CSS template. You should read the Doxygen documentation because > there are several rules/conventions to document properly a source > code. If the GTKmm Class Reference is generated with the Doxygen, we > could probably increase its quality providing a new Doxygen > configuration files or/and CSS file. Doxygen can also generate UML > schematics of a function or a sequence of calls and a lot more. Yes, we would welcome improvements to the Doxygen configuration, via git patches in bugzilla, please. I think I've tried various things in the past to do things like grouping constructors and sorting methods alphabetically, without success. murrayc murrayc com www.murrayc.com www.openismus.com ------------------------------------------------------------------------------ ************************************************** This email and any files transmitted with it are confidential and intended solely for the use of the individual or entity to whom they are addressed. If you have received this email in error, please notify the system manager. This footnote also confirms that this email message has been swept by the mailgateway **************************************************
Attachment:
GTKmmDoxygenConfigFile.cfg
Description: GTKmmDoxygenConfigFile.cfg