Re: [Doxygen-users] Making an Easy and fast readable C Library Manual reference.(TODO-Suggestions)
Brought to you by:
dimitri
From: Toni M. <ton...@wa...> - 2001-11-20 18:09:16
|
> You can then start to get clever : Your public documentation has > Doxygen's recursive input switched off. If you have a second config fil= e > with the recursion switched on and looking for the dot-c/dot-cpp files > as well, bingo, nicely formatted documentation of the internals of the > library for anyone who needs to maintain it :-) I'm working on two config files. doxyfile.refman doxyfile.devel the first have switched off the recursive option. the input secction has = a=20 list of header files : INPUT =3D <myobject1.h> \ <myobject2.h> \ ... <myobjectX.h>=20 The second one ,recursive tag is switched on. When the reference manual are generated, secction FILES shows all=20 <myobjectX.h> , but the user should only include in your applications.=20 <mylib.h>. I can move files to adapt the documentation, because the doc tags are=20 written in <myobjectX.h>=20 ( and I think is a bad goal , to change architecture design features only= for=20 doxygen doc generation , Doxygen like a source code documentation tool ma= y=20 addapt to any design , I was been studing and working on my lib design fo= r 2=20 years and I will not change it , expecting for a perfect documentation) --=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 |