[Development] Removing macros from Qdoc

casper.vandonderen at nokia.com casper.vandonderen at nokia.com
Thu Mar 1 14:15:07 CET 2012


Hi,

We are removing some macros from qdoc and replacing them with proper qdoc commands.

The following are the results:
-We are going to standardize on Doxygen, this means:
-\e will output italic (emphasized) text. In HTML and DITAXML output this will be <i>, Doxygen outputs <em> for HTML, but DITAXML does not support that.
-\i will be removed, since it could mean both italic or list item (depending if you included the macros.qdocconf file)
-\li will be used for list items instead of \o (\o will be removed)
-\b will be used for bold.
-\note was implemented as both a macro and a command. The macro will be removed.

To not make it all overly dramatic: all of \i \o \bold will keep existing for now (as proper commands).
This is necessary for Qt Creator (which should be able to be built with both Qt4 qdoc and Qt5 qdoc and for your own projects which might use qdoc. The usage of these command will give a debug warning though.

I am currently in the process of replacing all of these qdoc commands inside all of the Qt modules, we will try to push the qdoc changes and documentation changes all in one go (the qdoc changes are visible in Gerrit already).


Casper
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.qt-project.org/pipermail/development/attachments/20120301/7ee65e1d/attachment.html>


More information about the Development mailing list