Changeset 109572 in webkit


Ignore:
Timestamp:
Mar 2, 2012 6:25:38 AM (12 years ago)
Author:
commit-queue@webkit.org
Message:

[Qt] Documentation cleanup
​https://bugs.webkit.org/show_bug.cgi?id=80131

Patch by Casper van Donderen <​casper.vandonderen@nokia.com> on 2012-03-02
Reviewed by Simon Hausmann.

QDoc uses different commands to do bold, lists, and italics.
This change updates the documentation accordingly.
QTBUG-24578

  • Api/qwebframe.cpp:
  • Api/qwebhistory.cpp:
  • Api/qwebinspector.cpp:
  • Api/qwebpage.cpp:
  • Api/qwebpluginfactory.cpp:
  • Api/qwebsettings.cpp:
  • declarative/qdeclarativewebview.cpp:
  • docs/qtwebkit-bridge.qdoc:
  • docs/qtwebkit.qdoc:
  • docs/qtwebkit.qdocconf:
Location:
trunk/Source/WebKit/qt
Files:
11 edited

Legend:

Unmodified
Added
Removed

  • trunk/Source/WebKit/qt/Api/qwebframe.cpp

    r107787 r109572  
    784784    Given the above HTML code the metaData() function will return a map with two entries:
    785785    \table
    786     \header \o Key
    787             \o Value
    788     \row    \o "description"
    789             \o "This document is a tutorial about Qt development"
    790     \row    \o "keywords"
    791             \o "Qt, WebKit, Programming"
     786    \header \li Key
     787            \li Value
     788    \row    \li "description"
     789            \li "This document is a tutorial about Qt development"
     790    \row    \li "keywords"
     791            \li "Qt, WebKit, Programming"
    792792    \endtable
    793793

  • trunk/Source/WebKit/qt/Api/qwebhistory.cpp

    r81484 r109572  
    5454
    5555  \table
    56   \header \o Function      \o Description
    57   \row    \o title()       \o The page title.
    58   \row    \o url()         \o The location of the page.
    59   \row    \o originalUrl() \o The URL used to access the page.
    60   \row    \o lastVisited() \o The date and time of the user's last visit to the page.
    61   \row    \o icon()        \o The icon associated with the page that was provided by the server.
    62   \row    \o userData()    \o The user specific data that was stored with the history item.
     56  \header \li Function      \li Description
     57  \row    \li title()       \li The page title.
     58  \row    \li url()         \li The location of the page.
     59  \row    \li originalUrl() \li The URL used to access the page.
     60  \row    \li lastVisited() \li The date and time of the user's last visit to the page.
     61  \row    \li icon()        \li The icon associated with the page that was provided by the server.
     62  \row    \li userData()    \li The user specific data that was stored with the history item.
    6363  \endtable
    6464

  • trunk/Source/WebKit/qt/Api/qwebinspector.cpp

    r98162 r109572  
    5151    \note A QWebInspector will display a blank widget if either:
    5252    \list
    53         \o page() is null
    54         \o QWebSettings::DeveloperExtrasEnabled is false
     53        \li page() is null
     54        \li QWebSettings::DeveloperExtrasEnabled is false
    5555    \endlist
    5656
    … …  
    6161    QWebPage and are allocated the first time that:
    6262    \list
    63         \o an element is inspected
    64         \o the QWebInspector is shown.
     63        \li an element is inspected
     64        \li the QWebInspector is shown.
    6565    \endlist
    6666
    … …  
    9999    Bind this inspector to the QWebPage to be inspected.
    100100
    101     \bold {Notes:}
     101    \b {Notes:}
    102102    \list
    103         \o There can only be one QWebInspector associated with a QWebPage
     103        \li There can only be one QWebInspector associated with a QWebPage
    104104           and vice versa.
    105         \o Calling this method with a null \a page will break the current association, if any.
    106         \o If \a page is already associated to another QWebInspector, the association
     105        \li Calling this method with a null \a page will break the current association, if any.
     106        \li If \a page is already associated to another QWebInspector, the association
    107107           will be replaced and the previous QWebInspector will become unbound
    108108    \endlist

  • trunk/Source/WebKit/qt/Api/qwebpage.cpp

    r109542 r109572  
    37413741    In this string the following values are replaced at run-time:
    37423742    \list
    3743     \o %Platform% expands to the windowing system followed by "; " if it is not Windows (e.g. "X11; ").
    3744     \o %Security% expands to "N; " if SSL is disabled.
    3745     \o %Subplatform% expands to the operating system version (e.g. "Windows NT 6.1" or "Intel Mac OS X 10.5").
    3746     \o %WebKitVersion% is the version of WebKit the application was compiled against.
    3747     \o %AppVersion% expands to QCoreApplication::applicationName()/QCoreApplication::applicationVersion() if they're set; otherwise defaulting to Qt and the current Qt version.
     3743    \li %Platform% expands to the windowing system followed by "; " if it is not Windows (e.g. "X11; ").
     3744    \li %Security% expands to "N; " if SSL is disabled.
     3745    \li %Subplatform% expands to the operating system version (e.g. "Windows NT 6.1" or "Intel Mac OS X 10.5").
     3746    \li %WebKitVersion% is the version of WebKit the application was compiled against.
     3747    \li %AppVersion% expands to QCoreApplication::applicationName()/QCoreApplication::applicationVersion() if they're set; otherwise defaulting to Qt and the current Qt version.
    37483748    \endlist
    37493749*/

  • trunk/Source/WebKit/qt/Api/qwebpluginfactory.cpp

    r95901 r109572  
    182182    The above object element will result in a call to create() with the following arguments:
    183183    \table
    184     \header \o Parameter
    185             \o Value
    186     \row    \o mimeType
    187             \o "application/x-pdf"
    188     \row    \o url
    189             \o "http://qt.nokia.com/document.pdf"
    190     \row    \o argumentNames
    191             \o "showTableOfContents" "hideThumbnails"
    192     \row    \o argumentVaues
    193             \o "true" "false"
     184    \header \li Parameter
     185            \li Value
     186    \row    \li mimeType
     187            \li "application/x-pdf"
     188    \row    \li url
     189            \li "http://qt.nokia.com/document.pdf"
     190    \row    \li argumentNames
     191            \li "showTableOfContents" "hideThumbnails"
     192    \row    \li argumentVaues
     193            \li "true" "false"
    194194    \endtable
    195195

  • trunk/Source/WebKit/qt/Api/qwebsettings.cpp

    r108505 r109572  
    704704    Returns the web site's icon for \a url.
    705705
    706     If the web site does not specify an icon \bold OR if the icon is not in the
     706    If the web site does not specify an icon \b OR if the icon is not in the
    707707    database, a null QIcon is returned.
    708708
    … …  
    851851
    852852   \a cacheMaxDead is the \e maximum number of bytes that dead objects should
    853    consume when the cache is \bold not under pressure.
     853   consume when the cache is \b not under pressure.
    854854
    855855   \a totalCapacity specifies the \e maximum number of bytes that the cache
    856    should consume \bold overall.
     856   should consume \b overall.
    857857
    858858   The cache is enabled by default. Calling setObjectCacheCapacities(0, 0, 0)

  • trunk/Source/WebKit/qt/ChangeLog

    r109549 r109572  
     12012-03-02  Casper van Donderen  <casper.vandonderen@nokia.com>
     2
     3        [Qt] Documentation cleanup
     4        https://bugs.webkit.org/show_bug.cgi?id=80131
     5
     6        Reviewed by Simon Hausmann.
     7
     8        QDoc uses different commands to do bold, lists, and italics.
     9        This change updates the documentation accordingly.
     10        QTBUG-24578
     11
     12        * Api/qwebframe.cpp:
     13        * Api/qwebhistory.cpp:
     14        * Api/qwebinspector.cpp:
     15        * Api/qwebpage.cpp:
     16        * Api/qwebpluginfactory.cpp:
     17        * Api/qwebsettings.cpp:
     18        * declarative/qdeclarativewebview.cpp:
     19        * docs/qtwebkit-bridge.qdoc:
     20        * docs/qtwebkit.qdoc:
     21        * docs/qtwebkit.qdocconf:
     22
    1232012-03-02  Simon Hausmann  <simon.hausmann@nokia.com>
    224

  • trunk/Source/WebKit/qt/declarative/qdeclarativewebview.cpp

    r97557 r109572  
    163163    This type is made available by importing the \c QtWebKit module:
    164164
    165     \bold{import QtWebKit 1.0}
     165    \b{import QtWebKit 1.0}
    166166
    167167    The WebView item includes no scrolling, scaling, toolbars, or other common browser
    … …  
    578578    Finds a zoom that:
    579579    \list
    580     \i shows a whole item
    581     \i includes (\a clickX, \a clickY)
    582     \i fits into the preferredWidth and preferredHeight
    583     \i zooms by no more than \a maxZoom
    584     \i is more than 10% above the current zoom
     580    \li shows a whole item
     581    \li includes (\a clickX, \a clickY)
     582    \li fits into the preferredWidth and preferredHeight
     583    \li zooms by no more than \a maxZoom
     584    \li is more than 10% above the current zoom
    585585    \endlist
    586586

  • trunk/Source/WebKit/qt/docs/qtwebkit-bridge.qdoc

    r87032 r109572  
    8080
    8181    \list
    82     \i \bold{Hybrid C++/script}: C++ application code connects a
     82    \li \b{Hybrid C++/script}: C++ application code connects a
    8383    signal to a script function. This approach is useful if you have
    8484    a QObject but don't want to expose the object itself to the scripting
    … …  
    8787    the connection between the C++ signal and the JavaScript slot.
    8888
    89     \i \bold{Hybrid script/C++}: A script can connect signals and slots
     89    \li \b{Hybrid script/C++}: A script can connect signals and slots
    9090    to establish connections between pre-defined objects that the
    9191    application exposes to the scripting environment. In this scenario,
    … …  
    9393    the connections is fully dynamic (script-defined).
    9494
    95     \i \bold{Purely script-defined}: A script can both define signal
     95    \li \b{Purely script-defined}: A script can both define signal
    9696    handler functions (effectively "slots written in JavaScript"),
    9797    \e{and} set up the connections that utilize those handlers. For

  • trunk/Source/WebKit/qt/docs/qtwebkit.qdoc

    r99196 r109572  
    107107
    108108    \table
    109     \header \o Linux/Unix (X11)
    110     \row \o
     109    \header \li Linux/Unix (X11)
     110    \row \li
    111111    \list
    112     \o \c{.mozilla/plugins} in the user's home directory
    113     \o \c{.netscape/plugins} in the user's home directory
    114     \o System locations, such as
     112    \li \c{.mozilla/plugins} in the user's home directory
     113    \li \c{.netscape/plugins} in the user's home directory
     114    \li System locations, such as
    115115    \list
    116     \o \c{/usr/lib/browser/plugins}
    117     \o \c{/usr/local/lib/mozilla/plugins}
    118     \o \c{/usr/lib/firefox/plugins}
    119     \o \c{/usr/lib64/browser-plugins}
    120     \o \c{/usr/lib/browser-plugins}
    121     \o \c{/usr/lib/mozilla/plugins}
    122     \o \c{/usr/local/netscape/plugins}
    123     \o \c{/opt/mozilla/plugins}
    124     \o \c{/opt/mozilla/lib/plugins}
    125     \o \c{/opt/netscape/plugins}
    126     \o \c{/opt/netscape/communicator/plugins}
    127     \o \c{/usr/lib/netscape/plugins}
    128     \o \c{/usr/lib/netscape/plugins-libc5}
    129     \o \c{/usr/lib/netscape/plugins-libc6}
    130     \o \c{/usr/lib64/netscape/plugins}
    131     \o \c{/usr/lib64/mozilla/plugins}
     116    \li \c{/usr/lib/browser/plugins}
     117    \li \c{/usr/local/lib/mozilla/plugins}
     118    \li \c{/usr/lib/firefox/plugins}
     119    \li \c{/usr/lib64/browser-plugins}
     120    \li \c{/usr/lib/browser-plugins}
     121    \li \c{/usr/lib/mozilla/plugins}
     122    \li \c{/usr/local/netscape/plugins}
     123    \li \c{/opt/mozilla/plugins}
     124    \li \c{/opt/mozilla/lib/plugins}
     125    \li \c{/opt/netscape/plugins}
     126    \li \c{/opt/netscape/communicator/plugins}
     127    \li \c{/usr/lib/netscape/plugins}
     128    \li \c{/usr/lib/netscape/plugins-libc5}
     129    \li \c{/usr/lib/netscape/plugins-libc6}
     130    \li \c{/usr/lib64/netscape/plugins}
     131    \li \c{/usr/lib64/mozilla/plugins}
    132132    \endlist
    133     \o Locations specified by environment variables:
     133    \li Locations specified by environment variables:
    134134    \list
    135     \o \c{$MOZILLA_HOME/plugins}
    136     \o \c{$MOZ_PLUGIN_PATH}
    137     \o \c{$QTWEBKIT_PLUGIN_PATH}
     135    \li \c{$MOZILLA_HOME/plugins}
     136    \li \c{$MOZ_PLUGIN_PATH}
     137    \li \c{$QTWEBKIT_PLUGIN_PATH}
    138138    \endlist
    139139    \endlist
    … …  
    141141
    142142    \table
    143     \header  \o Windows
    144     \row \o
     143    \header  \li Windows
     144    \row \li
    145145    \list
    146     \o The user's \c{Application Data\Mozilla\plugins} directory
    147     \o Standard system locations of plugins for Quicktime, Flash, etc.
     146    \li The user's \c{Application Data\Mozilla\plugins} directory
     147    \li Standard system locations of plugins for Quicktime, Flash, etc.
    148148    \endlist
    149149    \endtable
    150150
    151151    \table
    152     \header \o Mac OS X
    153     \row \o
     152    \header \li Mac OS X
     153    \row \li
    154154    \list
    155     \o \c{Library/Internet Plug-Ins} in the user's home directory
    156     \o The system \c{/Library/Internet Plug-Ins} directory
     155    \li \c{Library/Internet Plug-Ins} in the user's home directory
     156    \li The system \c{/Library/Internet Plug-Ins} directory
    157157    \endlist
    158158    \endtable

  • trunk/Source/WebKit/qt/docs/qtwebkit.qdocconf

    r89832 r109572  
    1818macro.aring.HTML        = "&aring;"
    1919macro.Auml.HTML         = "&Auml;"
    20 macro.author            = "\\bold{Author:}"
     20macro.author            = "\\b{Author:}"
    2121macro.br.HTML           = "<br />"
    2222macro.BR.HTML           = "<br />"
    … …  
    2424macro.eacute.HTML       = "&eacute;"
    2525macro.iacute.HTML       = "&iacute;"
    26 macro.gui               = "\\bold"
     26macro.gui               = "\\b"
    2727macro.hr.HTML           = "<hr />"
    28 macro.key               = "\\bold"
    29 macro.menu              = "\\bold"
    30 macro.note              = "\\bold{Note:}"
     28macro.key               = "\\b"
     29macro.menu              = "\\b"
     30macro.note              = "\\b{Note:}"
    3131macro.oslash.HTML       = "&oslash;"
    3232macro.ouml.HTML         = "&ouml;"
    … …  
    5151macro.n                         = "\\\\n"
    5252macro.r                         = "\\\\r"
    53 macro.i                         = "\\o"
    54 macro.i11                       = "\\o{1,1}"
    55 macro.i12                       = "\\o{1,2}"
    56 macro.i13                       = "\\o{1,3}"
    57 macro.i14                       = "\\o{1,4}"
    58 macro.i15                       = "\\o{1,5}"
    59 macro.i16                       = "\\o{1,6}"
    60 macro.i17                       = "\\o{1,7}"
    61 macro.i18                       = "\\o{1,8}"
    62 macro.i19                       = "\\o{1,9}"
    63 macro.i21                       = "\\o{2,1}"
    64 macro.i31                       = "\\o{3,1}"
    65 macro.i41                       = "\\o{4,1}"
    66 macro.i51                       = "\\o{5,1}"
    67 macro.i61                       = "\\o{6,1}"
    68 macro.i71                       = "\\o{7,1}"
    69 macro.i81                       = "\\o{8,1}"
    70 macro.i91                       = "\\o{9,1}"
     53macro.i                         = "\\li"
     54macro.i11                       = "\\li{1,1}"
     55macro.i12                       = "\\li{1,2}"
     56macro.i13                       = "\\li{1,3}"
     57macro.i14                       = "\\li{1,4}"
     58macro.i15                       = "\\li{1,5}"
     59macro.i16                       = "\\li{1,6}"
     60macro.i17                       = "\\li{1,7}"
     61macro.i18                       = "\\li{1,8}"
     62macro.i19                       = "\\li{1,9}"
     63macro.i21                       = "\\li{2,1}"
     64macro.i31                       = "\\li{3,1}"
     65macro.i41                       = "\\li{4,1}"
     66macro.i51                       = "\\li{5,1}"
     67macro.i61                       = "\\li{6,1}"
     68macro.i71                       = "\\li{7,1}"
     69macro.i81                       = "\\li{8,1}"
     70macro.i91                       = "\\li{9,1}"
    7171macro.img                       = "\\image"
    7272macro.endquote                  = "\\endquotation"
Note: See TracChangeset for help on using the changeset viewer.