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

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 m

[Development] FYI: Better usage of the global qdocconf in qtbase

(Since there are so many people working on the documentation now I thought it'd be okay to use the list). I created https://codereview.qt-project.org/#change,33974 to make the global qdocconf in qtbase more useful (and minimize duplication). This change assumes that -installdir will always be sp

Re: [Development] Request: Mark classes with \module in documentation

>> >>On Thu, Aug 23, 2012 at 07:30:23AM +, ext >>casper.vandonde...@nokia.com wrote: >>> example: >>> /*! >>>\class QObject >>>\inmodule QtCore >>> ... >>> */ >>> >> isn't it a *tad* weird that sources in a modularized package need to >> declare in which package they are, several hundr

[Development] Request: Mark classes with \module in documentation

Hi, To be able to properly generate modularized Qt documentation we need QDoc to know in which module a class resides and I need help with this if we want to get modularization (mostly) done before the Qt 5 release. Previously QDoc would guess to which module a class belonged by finding keywor

Re: [Development] How to build Qt5's docs?

>On Tue, Aug 21, 2012 at 9:03 AM, Alan Ezust wrote: >> >> The issue is that in the doc/html/qt.qhp file, on line 14348, is an xml >> element >> with a ref="". >> >> This is the problem I was having. >> What is interesting to know is what is on that line? And I bet you it >> is QDeclarativeImagePr

Re: [Development] How to build Qt5's docs?

Hi, There is an issue with the widgets-tutorial because the chinese docs are probably not parsed properly. The crash in qhelpgenerator however comes from missing \relates qdoc commands. Can you try cherry-picking https://codereview.qt-project.org/#change,32986 (or wait until it is integrated).

Re: [Development] How to build Qt5's docs?

Hi, I just fixed this in https://codereview.qt-project.org/#change,33170 After that integrates the documentation should build properly. Casper On 8/21/12 8:57 AM, "Ramsay Lincoln (Nokia-MP/Brisbane)" wrote: >On 08/21/2012 03:29 PM, ext Loaden wrote: >> It's still not work for me. > >My commen

Re: [Development] Change of QDoc command from \qmlclass to \qmltype

Hi, > Tasks for the doc team: > -implement change in QDoc, but gracefully deprecate the \qmlclass by >giving > a warning about using \instantiates instead. > -go through the modules and change the documentation. Notify the >maintainer. > -send email to the affected maintainers. Just to be clear:

Re: [Development] Can we bring back QT += declarative?

On 7/19/12 12:40 PM, "Knoll Lars (Nokia-MP/Oslo)" wrote: >On 6/29/12 11:37 PM, "ext Thiago Macieira" >wrote: > >>On quinta-feira, 28 de junho de 2012 23.53.51, martin.jo...@nokia.com >>wrote: >>> Reassigning "declarative" back to qtquick1 could be done. I'm not sure >>>that >>> is an improvem

Re: [Development] Qt5 beta, MinGW: undefined reference to `WinMain@16'

Hi, Which GCC is this (both for w32 and w64)? For KDE I tried to use 4.6.4 and we are having a lot of problems with that, so we are now waiting for a patched GCC 4.7.x Casper From: ext Loaden mailto:loa...@gmail.com>> Date: Wednesday, July 11, 2012 3:52 PM To: "shane.kea...@accenture.com

Re: [Development] Proposal: Remove QML from Qt's code base (OR: Should it be a requirement that Qt Modules are interoperable?)

> The modularization system already gives you this ability. If you do not build > the qtdeclarative module, it will not > install itself in the mkspecs/modules directory under QT_INSTALL_PATH and > will not be available as modules. > .pro files can check for the availability of a certain modul

[Development] Documentation sessions

Hi, At the Contributors Summit we held 2 documentation sessions. The main points for discussion were the current state of the documentation, examples and the cross-referencing of documentation. I am probably forgetting some point here, so please add them in a follow-up message. Current state: - M

Re: [Development] doc: need rename qdoc3 -> qdoc

Hi, First of all: the monolithic build in qtdoc will be removed once all modules contain their own "make docs" target, since that monolithic build does not allow the same filename in any module, in the future each module should probably have a page with: /*! \title [libraryname] index \

Re: [Development] Make qdoc an officially supported tool for generating QML API documentation

On 6/11/12 11:48 AM, "ext Sven Anderson" wrote: >Hi Casper, > >On 11.06.2012 10:32, casper.vandonde...@nokia.com wrote: >> We have been very busy to get qdoc running outside of Qt (I am starting >>to >> use qdoc as LaTeX-lite now if I just need an HTML page). I do agree that >> the qdoc manual sh

Re: [Development] Make qdoc an officially supported tool for generating QML API documentation

Hi, We have been very busy to get qdoc running outside of Qt (I am starting to use qdoc as LaTeX-lite now if I just need an HTML page). I do agree that the qdoc manual should be improved with examples that do not necessarily reflect how we use qdoc with Qt. All changes that we are doing to qdoc a

Re: [Development] doc: need rename qdoc3 -> qdoc

Hi, Technically this structure should not be used at all anymore, but rather the auto-magic we introduced. The preferred way is to specify QMAKE_DOCS = [qdocconf file], this will automatically set up a "make docs" target for this module. Casper From: ext Loaden mailto:loa...@gmail.com>> Date:

Re: [Development] UDS feedback

On 5/12/12 9:13 PM, "ext Girish Ramakrishnan" wrote: >1. Qt SDK vs Ubuntu repo install - Currently, Qt SDK is a separate >download from Nokia website. Ubuntu packages creator and Qt. This >could cause confusion as to which to choose. I think the decision made >here was that this is not entirely s

[Development] Examples: Move file/image list to bottom of file

Hi, Example: http://doc-snapshot.qt-project.org/5.0/mainwindows-application.html Currently we render the list of examples at the top of the page, as visible in the example. On that page you do not really get an idea about the example before scolling down (1280x800 resolution). Therefore I would

Re: [Development] No implementation hints in Qt Documentation

On 5/3/12 12:30 PM, "ext Thiago Macieira" wrote: >> >>This is something that integrates well with the open governance concept >>too, as I think that there's still a considerable gap between users and >>contributors of Qt. Maybe this is something to consider in order to >>narrow it a little more

Re: [Development] Qt 5.0 beta and final timelines

> >In the meantime we can/should think about doing another alpha. Thiago >proposed that one option here could be to simply release the first source >package that works on all platforms as the second alpha. Like that we >don't >use any additional resources and time on creating that second alpha. >

[Development] Documentation bug maintenance

Hi all, Thiago mentioned some time ago that all bugs that nobody is working on should be set to "Unassigned". Therefore I would like to propose that the QTBUG "Documentation" component and QTWEBSITE "doc.qt.nokia.com" component set the assignee to "Unassigned" by default to allow anyone in the

Re: [Development] QtHelp Module

On 4/25/12 5:01 PM, "ext Jordi Pujol" wrote: >Hi all, > >I'm trying to embed a context-sensitive help system to my app. And I >wonder why QtHelp module was left in the middle :-( > >I'll try to explain : you create your fancy-shiny-great-rich html/css >based documentation ( doxygen or similar ) a

Re: [Development] Towards a Qt 5 beta: Documentation

Hi, I just cut out the rest of the email for clarity. (great that you would want to help) I just want to talk about the inherits and inherited by problem. "Inherits" should always work, because you compile the Qt code that way (you cannot subclass a class that doesn't exist yet). I just want to

Re: [Development] How to create new Qt modules or tools

H, > >Thanks Casper. You didn't mention examples, but the wiki says they go to >the examples directory. > I explicitly left out mentioning examples, because they are a mess. Most of the current examples/example documentation need to be re-written, since they all link to widgets, or their document

Re: [Development] How to create new Qt modules or tools

Hi, > I am missing the recommendation for certain folders in there, like > 1) doc: probably most important since modules should be documented. > 2) examples: this is probably also important because examples would be > nice to have for the add-on modules as well. I edited the location for doc to b

Re: [Development] important: upcoming rename of _qpa.h to _p.h

Hi, On 4/18/12 4:03 PM, "ext Girish Ramakrishnan" wrote: >Since there's been no proposal, here's an alternate proposal: >1. We drop _qpa completely. So, it would become qplatformbackingstore.h >2. We teach syncqt that qplatform* is special and we move them all to >a special qpa/ directory. So, i

[Development] Removing the \compat QDoc command

Hi, We have multiple commands to mark documentation content as outdated: \deprecated, \obsolete and \compat. \compat was used for Qt3 compatibility. There are only 12 occurrences of \compat under qt5.git in the documentation, but none of that documentation actually gets printed. So please change t

Re: [Development] Towards a Qt 5 beta: Documentation

Hi, > >There are other tasks that seems to be missing. > >- What is documentation? Are we talking only about the API docs or also >about code examples, tutorials, demo videos? I don't want to talk about any of the non-API documentation for now, since that is also a mess that needs to be cleaned u

Re: [Development] Towards a Qt 5 beta: Documentation

On 4/13/12 10:32 AM, "ext Oswald Buddenhagen" wrote: >On Fri, Apr 13, 2012 at 07:04:42AM +, ext >casper.vandonde...@nokia.com wrote: >> You are correct, that is what will happen, the same as the current >>system. >> The thing is that people have difficulty understanding where >> QT_QML_QDOC

Re: [Development] Towards a Qt 5 beta: Documentation

On 4/13/12 7:34 AM, "Lincoln Ramsay" wrote: >On 04/13/2012 03:19 PM, Vandonderen Casper (Nokia-MP/Oslo) wrote: >> But I would be grateful if you would make a plan on how to turn qdoc >> into a mini-qmake so that qdoc can parse the .pro/sync.profile, so >> that we don't need the depends. Because t

Re: [Development] Towards a Qt 5 beta: Documentation

Hi, > We had cross-module links in both directions. We achieved this by > running qdoc twice per module. Once to get the .index (used for > resolving links) and again to build with the other modules' .index > files. The only way to avoid doing things twice would be to have more > intermediate step

Re: [Development] Towards a Qt 5 beta: Documentation

>> There are 2 main problems with the current system: >> 1. Nobody was running "make docs" on their local machines (and verifying the >> output). There are qdoc errors that were put in by developers last >> December. Having the documentation modularized will at some point >> (hopefully soon) allow

Re: [Development] Towards a Qt 5 beta: Documentation

>> While I understand the reasoning, I am not sure the limitations above >> are acceptable. At least, if I understand you correctly. >> >> I think that loosing all the cross links and all the inherited-by links >> that span modules is unaceptable. For instance, you would no longer be >> able to see

[Development] Towards a Qt 5 beta: Documentation

Hi everybody, TL;DR: We need to change the way Qt does documentation. A lot of things will change and we need help from everybody. As mentioned by Lars: We should make sure the quality of the documentation for Qt 5.0 is as high as possible. To get and keep our documentation in shape for Qt 5.0 a

Re: [Development] Missing "QML Doc"

qtdoc/doc/doc.pri Casper From: development-bounces+casper.vandonderen=nokia@qt-project.org [development-bounces+casper.vandonderen=nokia@qt-project.org] on behalf of ext Johan Thelin [e8jo...@gmail.com] Sent: Tuesday, March 27, 2012 10:47 AM To

[Development] Qt Namespace enums defined in QTextDocument

Hi, The Qt::HitTestAccuracy and Qt::WhiteSpaceMode enum are defined in QTextDocument (which is in QtGUI), but they are documented in the Qt Namespace, which is in QtCore. This obviously does not work if we want to modularize the documentation on a library level. I have no idea how to solve thi

[Development] Documentation snapshots available on doc-snapshot.qt-project.org

Hello, Documentation snapshots will now be published at http://doc-snapshot.qt-project.org Qt and QDoc are already there. Qt Creator and Qt Installer Framework will be available later (today/early next week) Rewrites will be put in place from doc.qt.nokia.com to doc-snapshot.qt-project.org for

Re: [Development] Demos, examples, docs etc for Alpha release

you are free to update the documentation and add me as a reviewer. Casper From: development-bounces+casper.vandonderen=nokia@qt-project.org [development-bounces+casper.vandonderen=nokia@qt-project.org] on behalf of Gil Quim (Nokia-DXM

[Development] qdoc3 will be removed from qtdoc (and creating packages for Alpha)

Hi all, I just put the patch in that removes qdoc3 from qtdoc. From then onwards there will only be qdoc in qtbase. It is in Gerrit as http://codereview.qt-project.org/#change,19829 That is one of the changes I think we need for the alpha (to not ship both qdoc3 and qdoc) Another thing we need

Re: [Development] QDoc can't ignore Q_PROPERTY

So let's step back for a bit: >> I get not wanting to be forced into writing redundant 'emitted when >> this property has changed' documentation but excluding documentation >> that has been written for a signal seems a bit excessive, wouldn't it >> be enough to just omit the warning for an undocum

Re: [Development] QDoc can't ignore Q_PROPERTY

Just to make sure everybody understands: With this change applied all NOTIFY properties that are currently documented will not be documented anymore. If there are no objections before coming Tuesday (13 March) 09:00 Oslo time I will put this patch in. Casper ___

Re: [Development] QDoc can't ignore Q_PROPERTY

It might be that this was indeed an oversight. Can you create a bug report and assign it to me (I am not promising I have time to fix it now, or you can fix qdoc yourself and add me as reviewer ;-) ) Casper On 3/8/12 3:56 AM, "ext Girish Ramakrishnan" wrote: >Hi, > >On Wed, Mar 7, 2012 at 5:4

[Development] Moving qdoc to qtbase (and renaming from qdoc3 to qdoc)

Hi, We are currently integrating a patch that moves qdoc3 to qtbase and renames it to just qdoc. (http://codereview.qt-project.org/#change,18850) This allows qdoc to be bootstrapped, so that you always have qdoc available and that we can properly modularize the documentation. Why do we do this:

Re: [Development] QtSerialPort need to check the documentation.

A complete Qt 5 qt.index file can be found at http://doc.qt.nokia.com/5.0-snapshot/qt.index It's an XML file, so your browser will open is as such, but it is 15M, so use something like CURL/wget Casper On 3/4/12 8:19 AM, "ext Denis Shienkov" wrote: >Hi Debao. > >Thank you. > >Best regards, >D

[Development] Removing macros from Qdoc

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 , Doxygen outputs for HTML, but DITAXML

Re: [Development] RFC: The Future of QDoc

On 2/13/12 1:00 AM, "ext craig.sc...@csiro.au" wrote: > >On 10/02/2012, at 5:13 AM, >mailto:marius.storm-ol...@nokia.com>> >mailto:marius.storm-ol...@nokia.com>> wrote: > >I think there are a few issues here: > >1) Only Dimitri touches Doxygen code, and it doesn't look like >contributions go in

Re: [Development] RFC: The Future of QDoc

On 2/10/12 8:07 AM, "ext Andre Somers" wrote: >Op 9-2-2012 19:13, marius.storm-ol...@nokia.com schreef: >> On 09/02/2012 10:33, ext Manuel Nickschas wrote: >>> On Thursday 09 February 2012 15:36:09 ext Olivier Goffart wrote: > I am working on QDoc part-time and we have been discussing some >>

Re: [Development] RFC: The Future of QDoc

On 2/9/12 10:44 PM, "ext BRM" wrote: >> From: "casper.vandonde...@nokia.com" > >>Just to add what I think to Marius' comments: >>1. Doxygen would need some extra features, the major one being QML, but >>also being able to use index files to easily link for instance the >>Creator docs to the Qt

Re: [Development] RFC: The Future of QDoc

> On 09/02/2012 10:33, ext Manuel Nickschas wrote: > > On Thursday 09 February 2012 15:36:09 ext Olivier Goffart wrote: I am working on QDoc part-time and we have been discussing some changes that we would like to implement to make qdoc more future proof. I have created a short list

Re: [Development] RFC: The Future of QDoc

Hi, > > > I nice ability QDoc would have is to support other output formats > > > like XML or JSON, the old QDoc had this feature but it was deprecated > > > and not documented at all. > > > > > > The PySide documentation is generated using the XML output of qdoc3, > > > but the current version of

Re: [Development] RFC: The Future of QDoc

On 2/9/12 3:15 PM, "ext Keno Fischer" wrote: >> Implement a new C++ parser > >Any plans on using Clang a parser? The wiki page mentioned Qt Creator's >AST, >but it seems like Qt Creator will be moving away from its own >implementation >in the future, so I think that might be something to consider

[Development] RFC: The Future of QDoc

Hello, I am working on QDoc part-time and we have been discussing some changes that we would like to implement to make qdoc more future proof. I have created a short list of the things we would like to do: http://developer.qt.nokia.com/wiki/Category:Tools::QDoc It comes down to: Implement a new