what causes this?
there is a
structure control
{
int V1;
int V2;
};
a declaration
struct control control_arrays;
within a function, a declaration of a pointer to the structure
struct control * table_pointer;
table_pointer=control_arrays
i.e. a pointer is set to point to a control structure, called control_arrays
there is a reference to
table_pointer->V1
This gets put in the HTML as
control::V1
First of all, this is NOT a reference to control directly. it
is table_pointer->V1
So what should be put in front of the function is
table_pointer->V1 which is the reference used in the function, not
control::V1 which is a class member, and there are no
classes here.
Once again, there is a disconnect between *what is used in the function*
and what doxygen picks up. Yes, doxygen figures out that table_pointer
points to a control structure, but since this is NOT C++, and there are NO
classes defined, it should NOT use a C++ type indentifier.
What this has forced me to do, since doxygen is failing to put the
references into the .rtf file,
is to go to the HTML docs, copy the "Refers to section, paste that into
notepad, and reselct it and copy it to the the clipboard, to get rid of
the linkages, so it is straight text, then past it into the RTF file.
THEN I have to take a lot of time to correct it so it actually documents
what is in the function.
I find this not only puzzling, but very frustrating.
Why isn't this thing smart enough to actually use what is in the function
when producing documentation.
Perhaps it needs a set of options use only C syntax, and use
descriptions from within the function body, and use the actual function
header rather than the prototype.
------------------------------------------------------------------------------
_______________________________________________
Doxygen-users mailing list
Doxygen-users@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/doxygen-users
