Hi to all.
I'm beginning writting the documentation of my C library, using Doxygen.
The fist document is a reference manual.
I can't disable some default's doxigen features.
---------------------------------------------
A) I dont want show the source code to developers. but I need include the=
*.c
files in the INPUT secctions.
B) I want disable all references to de definition of a function.:
Example:
char * gs_cda_drive_get_label ( GsCdaDrive * drv )
Parameters : Get a String containing The model of this GsCdaDrive Drive
Unit. Returns : A GsCdaDrive Object.
Definition at line 50 of file gscdadrive.c. <-------NO NO NO!!!!
C) Enums:
I asign a value to all "labels" in my enums.
Example:
enum MyEnum {
MYVAL_0 =3D 0,
MYVAL_1 =3D 3,
MYVAL_2 =3D 0x08,
}
The doxigen outputs , maintains the values, but I would like only showing
enum MyEnum {
MYVAL_0,
MYVAL_1,
MYVAL_2,
}
D) defines and Macros:
Due to internal design I need A lot of macro #defines
Can I document 'it. like a function, this is , hidding the body of the ma=
cro?
example:
#define DO_SOMETHING(a,b) \
({ \
XXXXXXX \
XXXXXX \
XXXXXX
}) \
I would like to document it like...
macro DO_SOMETHING(a,b)
returns : a boolean if a & b .....
--------------------------------------------------------
Can you help me please?
I have attached an html output file, that shows how macros dirty the
reference manual ( there are aprox 30 indocumented macros yet !!!).
Thanks to all.
And sorry by my poor English.
--
=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
(Barcelona) Spain.
CP: 08340
|
