[Development] Doc: What still needs to be done from a documentation/examples perspective.

[casper.vandonderen at nokia.com]

Hello all,

What still needs to be done for the Qt 5.0 documentation/examples (feel
free to add more):

Documentation:
- Verify the content of the current documentation.
  See the email from last week
http://www.mail-archive.com/development@qt-project.org/msg05889.html

- Modularize the remaining modules.
  QtBase is still in progress and a lot of other modules have not been
touched yet. A combination of my email from earlier this year (
http://www.mail-archive.com/development@qt-project.org/msg03059.html ),
the changes in qtbase/examples and
qtdeclarative/src/quick/doc/qtquick.qdocconf will explain the process. It
comes down to moving the docs for the examples to [module]examples/doc,
adding a qdocconf to [module]/src/[module]/doc and using the correct
relative paths.

- Make it possible to use global stylesheet images for all modules (QDoc
problem).
  The modular documentation stylesheet wants to use some icons for things
like previous and next page. These do not currently work and there does
not currently seem to be a way to make them work with the global
stylesheet, because of the relative paths that are used by the qdocconf
files

- "make install" targets for the modular documentation.
  The built documentation needs to be copied from [moduledir]/doc to
$(QT_INSTALL_DOCS)

- Verification that the Qt DevNet can handle a modularized documentation
package.
  The DevNet currently uses the monolithic documentation build from the
qtdoc module, if we would want to switch to the modularized way of
building documentation the DevNet also needs to be able to handle that.

- Fix QDoc errors
  There is some progress with a QDoc "sanity bot" which should lower the
inflow of new errors, the current errors should also be fixed.

Examples:
- Develop a "Qt demo Launcher" that can also be used for QtQuick 2
examples.
  The code of the Qt4 qtdemo application is in the qttools repository, but
that application does not support Qt Quick 2 examples, which makes it less
useful for Qt 5.

- Verify if the examples are still useful and showing the best usage of an
API.

There are also still discussions about doing a multi-pass qdoc run to link
modular documentation bi-directionally. A make target for this should
(probably) be added to qt5.git, so that a user does not have to go back
and forth between modules to run some form of"make docs".

I have decided to not be part of the Qt transition from Nokia to Digia,
but will keep being the maintainer for documentation (not full-time) and
will not have time to finish all of these tasks.



Casper