Changeset 690 for trunk/src


Ignore:
Timestamp:
Mar 16, 2010, 12:21:22 AM (15 years ago)
Author:
Dmitry A. Kuminov
Message:

docs: Fixed warnings and added some missing documentation for OS/2 specific classes.

Location:
trunk/src
Files:
9 edited

Legend:

Unmodified
Added
Removed

  • trunk/src/corelib/io/qfsfileengine.cpp

    r651 r690  
    912912  engine.
    913913
    914   For Windows, returns the canonicalized form of the current path used
    915   by the file engine for the drive specified by \a fileName.  On
    916   Windows, each drive has its own current directory, so a different
    917   path is returned for file names that include different drive names
    918   (e.g. A: or C:).
     914  For Windows and OS/2, returns the canonicalized form of the current path used
     915  by the file engine for the drive specified by \a fileName.  On Windows and on
     916  OS/2, each drive has its own current directory, so a different path is
     917  returned for file names that include different drive names (e.g. A: or C:).
    919918
    920919  \sa setCurrentPath()

  • trunk/src/corelib/io/qfsfileengine_os2.cpp

    r660 r690  
    192192}
    193193
    194 /*!
    195     \internal
    196 */
    197194void QFSFileEnginePrivate::nativeInitFileName()
    198195{
    … …  
    208205}
    209206
    210 /*!
    211     \internal
    212 */
    213207bool QFSFileEnginePrivate::nativeOpen(QIODevice::OpenMode openMode)
    214208{
    … …  
    303297}
    304298
    305 /*!
    306     \internal
    307 */
    308299bool QFSFileEnginePrivate::nativeClose()
    309300{
    … …  
    311302}
    312303
    313 /*!
    314     \internal
    315 
    316 */
    317304bool QFSFileEnginePrivate::nativeFlush()
    318305{
    … …  
    320307}
    321308
    322 /*!
    323     \internal
    324 */
    325309qint64 QFSFileEnginePrivate::nativeRead(char *data, qint64 len)
    326310{
    … …  
    384368}
    385369
    386 /*!
    387     \internal
    388 */
    389370qint64 QFSFileEnginePrivate::nativeReadLine(char *data, qint64 maxlen)
    390371{
    … …  
    392373}
    393374
    394 /*!
    395     \internal
    396 */
    397375qint64 QFSFileEnginePrivate::nativeWrite(const char *data, qint64 len)
    398376{
    … …  
    400378}
    401379
    402 /*!
    403     \internal
    404 */
    405380qint64 QFSFileEnginePrivate::nativePos() const
    406381{
    … …  
    408383}
    409384
    410 /*!
    411     \internal
    412 */
    413385bool QFSFileEnginePrivate::nativeSeek(qint64 pos)
    414386{
    … …  
    416388}
    417389
    418 /*!
    419     \internal
    420 */
    421390int QFSFileEnginePrivate::nativeHandle() const
    422391{
    … …  
    424393}
    425394
    426 /*!
    427     \internal
    428 */
    429395bool QFSFileEnginePrivate::nativeIsSequential() const
    430396{
    … …  
    556522}
    557523
    558 /*!
    559     Returns the canonicalized form of the current path used by the file
    560     engine for the drive specified by \a fileName.
    561 
    562     On OS/2, each drive has its own current directory, so a different
    563     path is returned for file names that include different drive names
    564     (e.g. A: or C:).
    565 
    566     \sa setCurrentPath()
    567 */
    568524QString QFSFileEngine::currentPath(const QString &fileName)
    569525{
    … …  
    698654}
    699655
    700 /*!
    701     \reimp
    702 */
    703656QAbstractFileEngine::FileFlags QFSFileEngine::fileFlags(FileFlags type) const
    704657{

  • trunk/src/corelib/io/qprocess_os2.cpp

    r659 r690  
    17421742}
    17431743
    1744 /*! \internal
    1745  */
    17461744bool QProcessPrivate::startDetached(const QString &program, const QStringList &arguments,
    17471745                                    const QString &workingDirectory, qint64 *pid)

  • trunk/src/corelib/kernel/qcoreapplication_pm.cpp

    r659 r690  
    9393    received. Reimplement this function if you want to process window
    9494    messages \a msg that are not processed by Qt. If you don't want
    95     the event to be processed by Qt, then return true and set \a result
    96     to the value that the window procedure should return. Otherwise
    97     return false.
     95    the event to be processed by Qt, then return true and set \a result to the
     96    value that the window procedure should return. Otherwise return false.
    9897
    9998    It is only directly addressed messages that are filtered. To
    … …  
    103102    QAbstractEventDispatcher::instance().
    104103*/
    105 bool QCoreApplication::pmEventFilter(QMSG * /*msg*/, MRESULT * /*rc*/)
     104bool QCoreApplication::pmEventFilter(QMSG * /*msg*/, MRESULT * /*result*/)
    106105{
    107106    return false;

  • trunk/src/corelib/kernel/qeventdispatcher_pm.cpp

    r666 r690  
    8080    processing. Its functionality is based on PM object windows. Once an
    8181    instance of this class is created, PM window messages can be sent or posted
    82     to it using send() or post() methods. Subclasses should override the
     82    to it using send() or post() methods. Subclasses should implement the
    8383    message() method to process sent or posted messages. The hwnd() method is
    8484    used whenever a PM window handle of this object window is necessary to be
    … …  
    215215
    216216    \note Can be called on any thread.
     217*/
     218
     219/*!
     220    \fn QPMObjectWindow::message(ULONG msg, MPARAM mp1, MPARAM mp2)
     221
     222    This method is called whenever a message \a msg with parameters \a mp1 and
     223    \a mp2 is received by this object window. Every subclass should implement
     224    this method to do actual message processing.
    217225*/
    218226

  • trunk/src/gui/image/qpixmap_pm.cpp

    r659 r690  
    233233
    234234/*!
    235     Returns a QPixmap that is equivalent to the given \a bitmap. If \a hbmMask
    236     is not NULLHANDLE, it should contain vertically adjacent AND and XOR masks
    237     for the given bitmap which will be used to create a mask for the returned
    238     QPixmap.
     235    Returns a QPixmap that is equivalent to the bitmap given in \a hbm. If \a
     236    hbmMask is not NULLHANDLE, it should contain vertically adjacent AND and XOR
     237    masks for the given bitmap which will be used to create a mask for the
     238    returned QPixmap.
    239239
    240240    Note that this method will attempt to auto-detect the presence of the real
    241241    alpha chennel in the high 8 bits of the 32-bit pixel value for each pixel if
    242     the \a bitmap has 1 plane and the 32-bit depth. This alpha channel will be
    243     used to create an alpha channel for the returned QPixmap.
     242    \a hbm has 1 plane and the 32-bit depth. This alpha channel will be used to
     243    create an alpha channel for the returned QPixmap.
    244244
    245245    \warning This function is only available on OS/2.
    … …  
    350350
    351351/*!
    352     Creates a \c HPOINTER from the given QIcon. Returns the \c HPOINTER handle.
     352    Creates a \c HPOINTER from the given \a icon. Returns the \c HPOINTER
     353    handle.
    353354
    354355    If \a isPointer is \c true, an icon size closest to the system pointer size
    … …  
    435436
    436437/*!
    437     Returns a QIcon that is equivalent to the given \a pointer. Optionally
    438     returns pixmaps used to comprise the icon in the respective arguments.
     438    Returns a QIcon that is equivalent to the pointer given in \a hpointer.
     439    Optionally returns pixmaps used to comprise the icon in \a pixmap and
     440    \a pixmapMini.
    439441
    440442    Note that this method will attempt to auto-detect the presence of the real

  • trunk/src/gui/kernel/qmime_pm.cpp

    r659 r690  
    12361236/*!
    12371237    \class QPMMime
    1238     \brief The QMPMime class maps open-standard MIME to OS/2 PM Clipboard
     1238    \brief The QPMMime class maps open-standard MIME to OS/2 PM Clipboard
    12391239    formats.
    12401240    \ingroup io
    … …  
    12701270    \endtable
    12711271
    1272     Note that all "x-mime:<mime>" formats use the CFI_POINTER storage type. That
    1273     is, the clipboard contains a pointer to the memory block containing the MIME
    1274     data in the corresponding format. The first 4 bytes of this memory block
    1275     always contain the length of the subsequent MIME data array, in bytes.
     1272    Note that all "x-mime:<mime>" formats use the \c CFI_POINTER storage type.
     1273    That is, the clipboard contains a pointer to the memory block containing the
     1274    MIME data in the corresponding format. The first 4 bytes of this memory
     1275    block always contain the length of the subsequent MIME data array, in bytes.
    12761276
    12771277    An example use of this class by the user application would be to map the
    … …  
    13211321
    13221322/*!
    1323     Unregisters the MIME type identified by \a id which was previously
     1323    Unregisters the MIME type identified by \a mimeId which was previously
    13241324    registered with registerMimeType().
    13251325*/
    … …  
    13401340
    13411341/*!
    1342     Allocates a block of shared memory of the given size and returns the address
    1343     of this block. This memory block may be then filled with data and returned
    1344     by convertFromMimeData() as the value of the CFI_POINTER type.
     1342    Allocates a block of shared memory of the given \a size and returns the
     1343    address of this block. This memory block may be then filled with data and
     1344    returned by convertFromMimeData() as the value of the \c CFI_POINTER type.
    13451345*/
    13461346// static
    … …  
    13661366
    13671367/*!
    1368     Frees memory allocated by allocateMemory(). Normally, not used because the
    1369     CFI_POINTER memory blocks are owned by the system after
     1368    Frees a memory block \a addr allocated by allocateMemory(). Normally, not
     1369    used because the \c CFI_POINTER memory blocks are owned by the system after
    13701370    convertFromMimeData() returns.
    13711371*/
    … …  
    13751375    DosFreeMem((PVOID)addr);
    13761376}
     1377
     1378/*!
     1379    \typedef QPMMime::QByteArrayList
     1380
     1381    A QList of QByteArray elemetns.
     1382*/
    13771383
    13781384/*!
    … …  
    14211427    \fn QList<MimeCFPair> QPMMime::mimesForFormats(const QList<ULONG> &formats) const
    14221428
    1423     Returns a list of mime types that will be created form the specified \a list
    1424     of \a formats, in order of precedence (the most suitable mime type comes
     1429    Returns a list of mime types that will be created form the specified list of
     1430    \a formats, in order of precedence (the most suitable mime type comes
    14251431    first), or an empty list if neither of the \a formats is supported by this
    14261432    converter. Note that each item in the returned list is actually a pair
    … …  
    14471453                                           QMimeData *mimeData)
    14481454
    1449     Returns a DragWorker instance suitable for converting \a mimeType to a set
    1450     of drag items for the Direct Manipulation (Drag And Drop) session. If this
    1451     converter does not support the given MIME type, this method should return 0.
     1455    Returns a DragWorker instance suitable for converting \a mimeType of the
     1456    given \a mimeData to a set of drag items for the Direct Manipulation (Drag
     1457    And Drop) session. If this converter does not support the given MIME type,
     1458    this method should return 0.
    14521459
    14531460    See the QPMMime::DragWorker class description for more information.
    … …  
    15141521
    15151522    This class is a DragWorker implementation that supports standard
    1516     DRM_SHAREDMEM and DRM_OS2FILE and rendering mechanisms. It uses
     1523    \c DRM_SHAREDMEM and \c DRM_OS2FILE and rendering mechanisms. It uses
    15171524    QPMMime::DefaultDragWorker::Provider subclasses to map mime types of the
    15181525    object being dragged to rendering formats and apply preprocessing of data
    … …  
    15411548
    15421549    This class is a DropWorker implementation that supports standard
    1543     DRM_SHAREDMEM and DRM_OS2FILE and rendering mechanisms. It uses
     1550    \c DRM_SHAREDMEM and \c DRM_OS2FILE and rendering mechanisms. It uses
    15441551    QPMMime::DefaultDropWorker::Provider subclasses to map various rendering
    15451552    formats to particular mime types and apply postprocessing of data after
    … …  
    16241631
    16251632/*!
    1626     Returns a string representation of the given clipboard format.
    1627     The string representation is obtained by querying the system atom table.
     1633    Returns a string representation of the given clipboard \a format. The
     1634    string representation is obtained by querying the system atom table.
    16281635*/
    16291636// static
    … …  
    16911698
    16921699/*!
    1693     Checks that the given drag \a item supports the DRM_OS2FILE rendering
     1700    Checks that the given drag \a item supports the \c DRM_OS2FILE rendering
    16941701    mechanism and can be rendered by a target w/o involving the source (i.e.,
    1695     DRM_OS2FILE is the first supported format and a valid file name with full
    1696     path is provided). If the function returns TRUE, \a fullName (if not NULL)
    1697     will be assigned the item's full source file name (composed from
     1702    \c DRM_OS2FILE is the first supported format and a valid file name with full
     1703    path is provided). If the function returns \c TRUE, \a fullName (if not
     1704    \c NULL) will be assigned the item's full source file name (composed from
    16981705    \c hstrContainerName and \c hstrSourceName fields).
    16991706 */
    … …  
    17101717        // DrgVerifyNativeRMF doesn't work on my system (ECS 1.2.1 GA):
    17111718        // it always returns FALSE regardless of arguments. Use simplified
    1712         // hstrRMF parsing to determine whether DRM_OS2FILE is the native
     1719        // hstrRMF parsing to determine whether \c DRM_OS2FILE is the native
    17131720        // mechanism or not (i.e. "^\s*[\(<]\s*DRM_OS2FILE\s*,.*").
    17141721
    … …  
    17701777
    17711778/*!
    1772     Parses the given \a rmfs list (full rendering mechanism/format specification)
    1773     and builds a \a list of mechanism branches. Each mechanism branch is also a
    1774     list, where the first item is the mechahism name and all subsequent items are
    1775     formats supported by this mechanism. Returns false if fails to parse \a rmf.
     1779    Parses the given \a rmfs list (the full rendering mechanism/format
     1780    specification) and builds a \a list of mechanism branches. Each mechanism
     1781    branch is also a list, where the first item is the mechahism name and all
     1782    subsequent items are formats supported by this mechanism. Returns false if
     1783    fails to parse \a rmfs.
    17761784
    17771785    \note The method clears the given \a list variable before proceeding.

  • trunk/src/network/socket/qlocalserver_os2.cpp

    r659 r690  
    140140}
    141141
    142 /*!
    143     \internal
    144 
    145     \sa QLocalServer::closeServer()
    146  */
    147142void QLocalServerPrivate::closeServer()
    148143{
    … …  
    161156}
    162157
    163 /*!
    164     \internal
    165 
    166     We have received a notification that we can read on the listen socket.
    167     Accept the new socket.
    168  */
    169158void QLocalServerPrivate::_q_onNewConnection()
    170159{

  • trunk/src/network/socket/qnativesocketengine_os2.cpp

    r659 r690  
    121121}
    122122
    123 /*! \internal
    124 
    125     Creates and returns a new socket descriptor of type \a socketType
    126     and \a socketProtocol.  Returns -1 on failure.
    127 */
    128123bool QNativeSocketEnginePrivate::createNewSocket(QAbstractSocket::SocketType socketType,
    129124                                         QAbstractSocket::NetworkLayerProtocol socketProtocol)
Note: See TracChangeset for help on using the changeset viewer.