[Development] We are planning to upgrade qdoc to use clang for parsing C++

[Marc Mutz]

On Thursday 25 February 2016 10:56:01 Smith Martin wrote:
> Send ideas for upgrading the Qt documentation to C++11.
> 
> 
> 1. Which C++11 constructs will be used in Qt?
> 
> 
> 2. Which of these should appear in the documentation?
> 
> 
> Send comments to the CC list.

It would be nice if std:: types and funcitons automatically linked to 
<lang>.cppreference.com.

override and final should indeed appear in the docs, but imo just as part of 
the function / class signature. Same for constexpr and noexcept, = default and 
= delete. If a function with override, = default, or = delete has no comment 
block, it should default to \reimp, \defaulted, and \deleted, resp., with no 
warning (whatever \defaulted, \deleted actually expand to).

The most interesting thing is special member functions.

For moves, I find it important that we describe the state of moved-from 
objects. Or we just document all move special members as "leaves the rhs 
object in a partially-formed state, in which the only valid operations on the 
object are assignment or destruction."

I don't think we should document dtors by default, except when done manually 
(e.g. for RAII classes, or QFIle, where it's important to note that the dtor 
closes the file).

Thanks,
Marc

-- 
Marc Mutz <marc.mutz at kdab.com> | Senior Software Engineer
KDAB (Deutschland) GmbH & Co.KG, a KDAB Group Company
Tel: +49-30-521325470
KDAB - The Qt Experts