qdoc: Added 2nd argument to \generate list classes command
authorMartin Smith <martin.smith@digia.com>
Mon, 28 Apr 2014 10:51:56 +0000 (12:51 +0200)
committerThe Qt Project <gerrit-noreply@qt-project.org>
Fri, 2 May 2014 10:40:44 +0000 (12:40 +0200)
commitc771aedc70a15ee29587788a9d9d73fdab65f84d
tree134137971f080ad77c4285a9a991108868b33100
parentd8f7cb1f2b433ab606436a8e1995f10ada21330d
qdoc: Added 2nd argument to \generate list classes command

The qdoc command \generatelist has an argument that tells
qdoc which list to generate. When the argument is "classes"
qdoc generates the "All C++ Classes" list. qdoc looks for a
common prefix for all the members of the list and sorts the
members of the list using the character that follows the
common prefix. The problem was that the common prefix "Q"
was hardcoded in qdoc.

This update allows the \generate list command to have a
second argument, which is the common prefix. If the common
prefix is not provided, qdoc sorts the members of the list
on the first character.

There is only one use of the \generatelist command with
the classes argument in Qt5. It is changed to be
\generatelist classes Q, and the qdoc user manual is
updated to reflect this change.

Task-number: QTBUG-38226
Change-Id: Icc556efa517501f5c95d36db0ca35977af76f664
Reviewed-by: Topi Reiniƶ <topi.reinio@digia.com>
doc/src/classes.qdoc