[Development] [docs/c++] How do we deal with the special member functions (copy/move ctor/assignment operator, dtor, default ctor)

[Smith Martin]

qdoc decides which members must be documented by parsing the .h file looking for the members that are not private. Any such member that does not later have a qdoc comment is a "documentation missing" error. It has simply always been that way, but we can change it if that makes sense. It does recognize the constructors and destructor. The way to tell qdoc to ignore a member is to give it a qdoc comment that contains nothing but "\internal"

martin
________________________________________
From: development-bounces+martin.smith=digia.com at qt-project.org [development-bounces+martin.smith=digia.com at qt-project.org] on behalf of Thiago Macieira [thiago.macieira at intel.com]
Sent: Saturday, August 02, 2014 6:21 PM
To: development at qt-project.org
Subject: Re: [Development] [docs/c++] How do we deal with the special member    functions (copy/move ctor/assignment operator, dtor, default ctor)

On Friday 01 August 2014 23:16:40 Marc Mutz wrote:
> That leaves the question how to deal with the documentation for these
> implicit  members.

Why do we have to document them in the first place? I hate having to write
documentation for a destructor that simply says "frees resources associated
with this object". That much is obvious: any self-respecting destructor will
do that and the same applies to copy and move constructors.

What we really want is to document which objects are copyable and which ones
aren't. And that is very simple: any object with Q_DISABLE_COPY is not
copyable, (almost) everything else is.

--
Thiago Macieira - thiago.macieira (AT) intel.com
  Software Architect - Intel Open Source Technology Center

_______________________________________________
Development mailing list
Development at qt-project.org
http://lists.qt-project.org/mailman/listinfo/development