Changes between Version 4 and Version 5 of QtWebKitDocContrib


Ignore:
Timestamp:
Jun 22, 2010 4:40:45 AM (11 years ago)
Author:
Henry Haverinen
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • QtWebKitDocContrib

    v4 v5  
    1414The qdoc markup is a simple wiki-like format. The qdoc tool is documented here: http://qt.gitorious.org/qt/pages/DocManual.
    1515
    16 For Windows users, the easiest way to get the qdoc3 command line tool is to install the Qt SDK for Windows and add the bin directory to the PATH. For instance, if you install Qt SDK version 2010.3 to the default location, the qdoc3.exe will be in C:\Qt\2010.03\qt\bin.
     16For Windows users, the easiest way to get the qdoc3 command line tool is to install the Qt SDK for Windows use the Qt command prompt from the Qt SDK folder in Start menu. Alternatively, you can install Qt SDK and add Qt's bin directory to your PATH environment variable. For instance, if you install Qt SDK version 2010.3 to the default location, the qdoc3.exe will be in C:\Qt\2010.03\qt\bin.
    1717
    1818On Mac OS X, the qdoc3 binary has not been previously included in the Qt SDK, but as of Qt 4.7 Beta II (to be released soon at the time of writing), the qdoc3 binary is included in the Qt SDK. After installation, qdoc3 should already be in the PATH.
     
    4545And to switch to a branch simply use {{{git checkout branchname}}}
    4646
     47== Building the documentation articles  ==
     48
     49To build the QtWebKit documentation simply run {{{make docs}}} in your build directory, i.e. {{{WebKitBuild/Release}}}. The output will be generated in HTML in the {{{doc/html}}} subdirectory.
     50
     51If you also need to work on the C++ API documentation that refers to the Qt API documentation, then you need to build Qt from sources. See http://trac.webkit.org/wiki/QtWebKitContrib for more information.
     52
     53
    4754== Submitting a documentation contribution ==
    4855
     
    6774TBD
    6875
    69 == Building the documentation articles  ==
    70 
    71 To build the QtWebKit documentation simply run {{{make docs}}} in your build directory, i.e. {{{WebKitBuild/Release}}}. The output will be generated in HTML in the {{{doc/html}}} subdirectory.
    72 
    73 If you also need to work on the C++ API documentation that refers to the Qt API documentation, then you need to build Qt from sources. See http://trac.webkit.org/wiki/QtWebKitContrib for more information.
    74 
    7576== Communication ==
    7677