Geek Answers Handbook

Doxygen and long class names

I have a good C ++ project where template programming is widely used, but it really is not. The fact is that some of my class names (with all the template parameters) become quite long. I use Doxygen for documentation.

This is usually not a problem, but lately I noticed that the list of classes is not readable, because the names of a long class make it too wide to fit on the screen.

Is there a way to make Doxygen split class names in the class list into more lines? Is there a way to hide the template class specializations from the list of classes while maintaining a common template class? Is there a better solution?

I managed to find a stupid job by hiding the classes in the namespace, and then immediately importing that namespace into the global namespace so that the names of these classes would not appear in the list if the namespace was not clicked or the level of detail was increased. The obvious drawback is that classes are no longer displayed in the list (some of them are quite important, and I would like them to be there).

I could also remove the following style:

.directory td.entry {
    white-space: nowrap;
}

This can be done by saving this:

.directory td.entry {
    white-space: normal;
}

as modify.csspointing it in HTML_EXTRA_STYLESHEET. However, there are more tags for word wrapping (for example, flex-wrap), so additional editing may be required.

+4
source share
1 answer

Finally, I went with the css change. I ended up using:

.directory td.entry {
    white-space: normal;
    /*width: 50%;*/ /* does not work, makes "Related Pages" look bad */
    min-width: 512px; /* better, unless you have a 640x480 screen */
}

doxygen_modify.css HTML_EXTRA_STYLESHEET ( , named doxygen.css, , - , , ).

+1

More articles:


All Articles