[Doxygen-develop] Re: [Doxygen-users] Making an Easy and fast readable C Library Manual reference.(T
Brought to you by:
dimitri
From: Toni M. <ton...@wa...> - 2001-11-20 18:32:47
|
> Let me add a big ditto to most of this. Doxygen is great, but I find i= t > is almost, but not quite there for documenting C code. I'm agree. But I think not much work is needed to get a better C=20 documentation using doxygen. =20 About Object Oriented C style , I think is not needen because we can work= on=20 \defgroup and \addgroup , to get a good doc structure. ( avoiding use the= =20 \file tag) . Inheritance structures can be easyly made using \ingroup ( Is what I'm do= ing). And I only miss , control on the order of modules or groups. Y have put the correct order in my INPUT section but the order in the tree browser is in reverse order (Perhaps a BUG????) My input section.... ------------------------------------ INPUT =3D ./src/gsound.h \ <---here \defgroup Gsound Init ./src/gsmathdefs.h \ <--- here \defgroup Gsound u= tils ./src/data/gsdata.h \ <--here \gsdata ./src/data/gsdataformat.h \ <--here \GsDataFormat ./src/data/gsdatachannelsys.h \ ./src/data/gsdatatimeenv.h \ ./src/data/gsdatatime.h \ ./src/data/gsdatabuffer.h \ ./src/data/gsdatawave.h \ etc... .... This is the output tree browser: ------------------------------------------- MODULES (browser) .... Gsound Basics and Tools.=20 Gsound Constants and utils=20 Gsound Initialization. <----First defined and last in the browser GSound : Basic Data Types=20 GsDataWave=20 GsDataBuffer=20 GsDataTime=20 GsDataTimeEnv=20 GsDataChannelSys=20 GsDataFormat <----First defined and last in the tree browser ..... etc ..... --------------------------------------------- --=20 =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D Toni Moreno Gim=E9nez =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D Pje de las rosas n=BA 22 Vilassar de Mar=20 (Barcelona) Espa=F1a CP: 08340 |