[Insight-developers] Doxygen Alphabetical Index : a feature

Luis Ibanez ibanez@choroid.cs.unc.edu
Sun, 7 Oct 2001 07:26:38 -0400 (EDT)


Hi,

The letter headers are back in the alphabetical
index in doxygen.


An unrelated and curious feature is present, however.

Classes declared inside classes appear correctly
in the alphabetical location of the internal class,
but produce an extra header (incorrectly) associated
with the initial of the external class.


For example:

class CellInterface {
  public:
   class Multivisitor {};
};


Produce an entry "CellInterface" in the "C" group,
that's fine.

A second entry: "CellInterface::Multivisitor" is
correctly ordered under "M", but it introduces a "C"
header in the "M" group.

The global effect of these spurious headers it to
produce the impression that the alphabetical index
is not ordered.

Same thing is happening to VTK documentation.
See for example:

     vtkFieldData::BasicIterator

which is in the "B" group with a "F" header over it.


This seems to be a feature of the algorithm that
introduces the headers in doxygen, as opposed a
configuration problem.



Luis