summaryrefslogtreecommitdiffstats
path: root/khtml/Mainpage.dox
diff options
context:
space:
mode:
Diffstat (limited to 'khtml/Mainpage.dox')
-rw-r--r--khtml/Mainpage.dox46
1 files changed, 46 insertions, 0 deletions
diff --git a/khtml/Mainpage.dox b/khtml/Mainpage.dox
new file mode 100644
index 000000000..9dc968d02
--- /dev/null
+++ b/khtml/Mainpage.dox
@@ -0,0 +1,46 @@
+/** @mainpage KDE HTML Parser and Widget
+
+If you want a fully-fledged HTML browser widget in your application,
+you can use KHTMLPart to do so.
+
+@code
+KUrl url = "http://www.kde.org";
+KHTMLPart *w = new KHTMLPart();
+w->openUrl(url);
+w->view()->resize(500, 400);
+w->show();
+@endcode
+
+For more information, see the documentation for KHTMLPart.
+
+Note that using KHTMLPart may introduce security vulnerabilities
+and unnecessary bloat to your application. Qt's text widgets are
+rich-text capable, and will interpret a limited subset of HTML.
+
+@authors
+Torben Weis \<weis@stud.uni-frankfurt.de\><br>
+Josip A. Gracin \<grac@fly.cc.fer.hr\><br>
+Martin Jones \<mjones@kde.org\><br>
+Waldo Bastian \<bastian@kde.org\><br>
+Lars Knoll \<knoll@kde.org\><br>
+Antti Koivisto \<koivisto@iki.fi\><br>
+Dirk Mueller \<mueller@kde.org\><br>
+Peter Kelly \<pmk@post.com\><br>
+George Staikos \<staikos@kde.org\><br>
+Allan Sandfeld Jensen \<kde@carewolf.com\><br>
+Germain Garand \<germain@ebooksfrance.org\><br>
+Maksim Orlovich \<maksim@kde.org\><br>
+KHTML has also heavily benefited from the work of Apple Computer, Inc.
+@maintainers
+Allan Sandfeld Jensen <br>
+Germain Garand<br>
+Maksim Orlovich
+
+@licenses
+@lgpl
+
+*/
+// DOXYGEN_REFERENCES = kdecore kdeui kio kparts kjs
+// DOXYGEN_EXCLUDE = test*.* html rendering xml misc ecma css imload pics test
+// DOXYGEN_SET_PROJECT_NAME = KHTML
+// vim:ts=4:sw=4:expandtab:filetype=doxygen