[Development] Documenting Qt 6 API breakages

[Paul Wicking]

> On 27 May 2020, at 17:22, Riitta-Leena Miettinen <Riitta-Leena.Miettinen at qt.io> wrote:
> 
> Hello,
>  
> How about using a similar approach to that used for documenting the CMake commands for each module in Qt 5.15?
>  
> That is:
>  
> 	• Create a qdoc file in each module that contains the breakages for that module and contains the \ingroup command migrate2qt6, or something like that.
> 	• Create the \group page in the qtdoc module for central access to the information.
>  
This seems like a sensible approach to me. The detailed documentation lives close to source and we can keep the higher level overview documentation in a single location.

P.

> Cheers,
>  
> Leena
>  
>  
> Leena Miettinen
> Sr. Documentation Engineer
>  
> The Qt Company GmbH
> Erich-Thilo-Str. 10
> D-12489 Berlin
> riitta-leena.miettinen at qt.io
> http://qt.io
>  
> Geschäftsführer: Mika Pälsi, Juha Varelius, Mika Harjuaho
> Sitz der Gesellschaft: Berlin, Registergericht: Amtsgericht Charlottenburg, HRB 144331 B
>  
>  
> Date: Wed, 27 May 2020 14:48:57 +0000
> From: Kai Köhne <Kai.Koehne at qt.io>
> To: "development at qt-project.org" <development at qt-project.org>
> Subject: [Development] Documenting Qt 6 API breakages
> Message-ID:
>         <AM0PR02MB4467BD9422064346A9571F2A98B10 at AM0PR02MB4467.eurprd02.prod.outlook.com>
>         
> Content-Type: text/plain; charset="iso-8859-1"
> 
> Hi,
> 
> We should start documenting the API changes that Qt 6.0 brings soon. This will allow getting people getting an overview, help early adopters, and will give us time to improve the documentation before the release.
> 
> Now I see that there are different paths taken:
> - Eskil and others have started listing changes in a page in the qtdoc repository, https://doc-snapshots.qt.io/qt6-dev/sourcebreaks.html 
> - I created a skeleton for Qt Core changes in the qtbase repository: https://codereview.qt-project.org/c/qt/qtbase/+/299664 . 
> 
> I wasn't aware of the existing page in qtdoc; Anyhow, from past experience I prefer having the documentation nearby the actual code. I therefore would like move the existing sections about Qt Quick, Qt OpenGL to the respective module documentation and let https://doc-snapshots.qt.io/qt6-dev/sourcebreaks.html just link to the module documentation pages.
> 
> Thoughts?
> 
> Kai
> 
> --
> Kai Köhne, Director R&D | The Qt Company
> 
> The Qt Company GmbH, Erich-Thilo-Straße 10, D-12489 Berlin
> Geschäftsführer: Mika Pälsi, Juha Varelius, Mika Harjuaho
> Sitz der Gesellschaft: Berlin, Registergericht: Amtsgericht Charlottenburg, HRB 144331 B
> 
> 
> 
> ------------------------------
> 
> Subject: Digest Footer
> 
> _______________________________________________
> Development mailing list
> Development at qt-project.org
> https://lists.qt-project.org/listinfo/development
> 
> 
> ------------------------------
> 
> End of Development Digest, Vol 104, Issue 63
> ********************************************
>  
> _______________________________________________
> Development mailing list
> Development at qt-project.org
> https://lists.qt-project.org/listinfo/development