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.

File:
1 edited

Legend:

Unmodified
Added
Removed

  • 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.
Note: See TracChangeset for help on using the changeset viewer.