[Doxygen-develop] Making an Easy and fast readable C Library Manual reference.(TODO-Suggestions)

[Toni M. <ton...@wa...>]

Well , First we should define what is "easy" and "fast readable" Manual.
I'm now using doxigen for my C Library , and I want to achieve a Referenc=
e=20
manual  that looks like  GLib and Gtk+  API reference Manual(=20
http://www.gtk.org/api/ )

I was been  testing diferent doxigen features, and I think it is really=20
posible to do a nice API doc like Glib uses ( for C users)

But I have detected some leaks in current features, in order  to do a per=
fect=20
API C reference manual.

------------------------------------------

1) * hide Enum Values.

2) * hide Macro definitions body. ( and document them like functions )


3) (Disable File List Section)

If you are documenting a like "Object Oriented C code" is common use a co=
uple=20
of source code files for each "object."=20

myobject.c
myobject.h=20

But the final library usually have and unique header to include.
By example mi lib has while developing the first release aprox 25 headers

but only one is needed to use the lib.

#include <mylibheader.h>

and mylibheader.h  contains the actual header files.

#include <object1.h>
#include <object2.h>
.....
#include <object3.h>

I want to say that I don't need a "File List" Section in the HTML Output =
 ,=20
and I can't disable it  now.

4)  Add an arbitrary header file per group

Something like..

/** @addgroup myobject=20
*	@mygroupheader  mylibheader.h <<------=20
*	@{
*/

Well I'm making "Object" documentation one per group
and the grouping feature runs OK. but  I can't specify what's header's fi=
le=20
needs this group.

--------------------------------------

There are some other little things that can be added , but the most impor=
tat=20
are the before explained. ( 1 and 2 for both ,C and C++ API reference man=
uals)

About other features, ALL are running OK and the feel and look of my manu=
al=20
is olmost the same as GLib and Gtk manuals. ( only changing colors of=20
course..).

I can search for some other features , If any developer ask me.

Lots of Thanks.

--=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
-----------------
Tel:937598149
Tel: 699706656
-----------------