| | 32 | |
| | 33 | == Documentation TODO == |
| | 34 | |
| | 35 | This is a list of items to do regarding the API / overview documentation of QtWebKit that we'd like to fix before the release: |
| | 36 | |
| | 37 | * Zero qdoc warnings |
| | 38 | * Review existing API documentation: |
| | 39 | * Widget plugins |
| | 40 | * Classes (QWebPage, QWebHistory, etc.) |
| | 41 | * Expand and combine sentences, adding missing \sa links, etc. |
| | 42 | * Ask the Qt support staff about things they're aware of that are bad or missing in the current docs. |
| | 43 | * Architectural overview (QWebView, QGraphicsWebView, QWebPage) - update existing diagram |
| | 44 | * Make sure that all new functions have the \since tag |
| | 45 | * Figure out how to expand \since 2.0 to "Since QtWebKit 2.0", or consider a \since 4.7 and \sinceqtwebkit 2.0 |
| | 46 | * Task orientation documentation: |
| | 47 | * How to implement a desktop and a mobile/embedded browser |
| | 48 | * JavaScript bridge documentation (Noam) |
| | 49 | |
