GNOME Bugzilla – Bug 683897
class list not sorted?
Last modified: 2013-12-24 18:59:42 UTC
I have a bunch of classes that mainly live in a single namespace. I would like these to be sorted in the class list, but they are not. Is there a way to cause them to be sorted? (Note: I have tried setting SORT_BY_SCOPE_NAME to both YES and NO, to no effect. The classes show up in the same quasi-random order either way.)
Can you please attach a self-contained example (source+config file in a tar or zip) that allows me to reproduce the problem.
Created attachment 224536 [details] simple example showing the problem I think I figured out the problem. Somewhere, the file path is participating in sorting. From the perspective just looking at the documentation, this is REALLY confusing (i.e. order looks random and is not intuitive), especially as (in my 'production' case) some of the participating headers are generated (and thus live in the build directory, not the source directory). A vastly simplified test case is attached. For me, this gives the class list sort order 'cow, pig, cat, dog', which is not sorted in any obviously logical manner until you consider the file paths farm/cow.h, farm/pig.h house/cat.h house/dog.h. I could see having an option to control this behavior similar to SORT_BY_SCOPE_NAME, but think there should at minimum be the option to not sort in this manner.
Test case has been provided. Problem still occurs with version 1.8.4 (-git)
The option that controls this is SORT_BRIEF_DOCS. Setting this to YES will give an alphabetically sorted class list. I'll add a note about this to the documentation.
...what if I don't want class members sorted? I'd strongly prefer there to be a separate option (or just always sort the class list; I'm not sure it makes sense not to sort that the way it does to not sort members).
This bug was previously marked ASSIGNED, which means it should be fixed in doxygen version 1.8.6. Please verify if this is indeed the case. Reopen the bug if you think it is not fixed and please include any additional information that you think can be relevant (preferrably in the form of a self-contained example).