tools/qdoc3/TODO.txt
changeset 0 1918ee327afb
equal deleted inserted replaced
-1:000000000000 0:1918ee327afb
       
     1     * fix QWSPointerCalibrationData::devPoints and qwsServer
       
     2     * Fix QMenu::addAction(QAction *) overload, "using" etc.
       
     3     * fix space between two tables using <p></p>
       
     4     * qpixmap-qt3.html; remove 8 public functions inherited from QPaintDevice
       
     5     * \variable array
       
     6     * Added support for parameterless macros (e.g. \macro Q_OBJECT).
       
     7     * Made qdoc stricter regarding the data types (e.g. can't use \enum to document a typedef).
       
     8     * Parse QT_MODULE() macro and generate proper warnings for the various editions.
       
     9     * Fix parsing of \image following \value (e.g. qt.html).
       
    10     * Don't turn X11 and similar names into links.
       
    11     * Added automatic links from getters to setters and vice versa.
       
    12     * Support \module and show which module each class is from.
       
    13     * Use bullet list for the list of all functions, now that
       
    14       Assistant handles these gracefully.
       
    15     * Fix occasional crash caused by misuse of const_cast().
       
    16     * Provide clearer error messages when resolves fail.
       
    17 
       
    18 
       
    19 
       
    20 
       
    21 CHECK:
       
    22 
       
    23   * Identify editions
       
    24   * Automatic \sa getter setter
       
    25   * \macro Q_OBJECT
       
    26 
       
    27 MUST HAVES:
       
    28 
       
    29   * resolve [gs]etters for \sa using base class
       
    30 
       
    31   * fix \overload when one is a signal and the other a normal function
       
    32   * use "project" for .dcf files
       
    33   * functions.html: include the types from QtGlobal as well as the functions (whatever that means)
       
    34 
       
    35   * nice template function/class syntax
       
    36   * spellchecker: built-in vs. builtin
       
    37 
       
    38   * verbose mode for functions that don't exist
       
    39   * No links to Porting Guide sections (e.g. QStringList)
       
    40   * link toggled(bool)
       
    41   * autolink foo(1)
       
    42   * handle using correctly
       
    43   * QObject "reentrant" list: duplicates
       
    44   * operator<< \overload
       
    45   * \compat \overload
       
    46   * qWarning() link
       
    47   * operator<<() autolink
       
    48 
       
    49   * get rid of spurious 'global' functions
       
    50   * Make automatic links in code work
       
    51 
       
    52   * Fix encoding bug (see Important email from Simon Hausmann)
       
    53   * Make links to QFoo::bar().baz() work
       
    54   * Fix automatic links in \sectionX (e.g. qt4-getting-started.html)
       
    55   * Provide a "List of all properties" page.
       
    56 
       
    57   * expand QObjectList -> QList<QObject *>
       
    58   * make \macro work (?)
       
    59   * warning for unnamed parameters in property access functions
       
    60   * \center...\endcenter
       
    61 
       
    62   * warning for undocumented enum values
       
    63 
       
    64 LINKS:
       
    65 
       
    66   * explanation following nonstandard wording warning
       
    67 
       
    68   * omit \overload in operator<< and operator>>
       
    69   * make operator-() unary and binary independent functions (no \overload)
       
    70   * fix \overload
       
    71   * fix \legalese
       
    72   * remove warning for undocumented enum item like QLocale::LastLanguage
       
    73   * improve the \a warnings for overloads; if one overload documents a para, fine
       
    74 
       
    75   * implement \sidebar
       
    76 
       
    77   * implement qbook
       
    78 
       
    79   * implement \legalesefile
       
    80 
       
    81   * show in which module each class is
       
    82   * list namespaces, list header files
       
    83 
       
    84 
       
    85 NICE FEATURES:
       
    86   * implement inheritance tree for each class (as a PNG)
       
    87   * avoid <p>...</p> in table/item cells without relying on horrible kludge
       
    88   * prevent macros from having same name as commands
       
    89   * be smart about enum types Foo::Bar vs. Bar when comparing functions
       
    90   * be smart about const & non-const when comparing functions
       
    91 
       
    92 OTHER:
       
    93   * make qdoc run faster
       
    94   * make sure \headerfile works even if specified after \relates
       
    95 
       
    96   * use qtstyle.css instead of inline style for each page