From 8a446182252e58e75cbe8d2fb715abfc1fc8f9ad Mon Sep 17 00:00:00 2001 From: Niels Sascha Reedijk Date: Wed, 8 Aug 2007 10:29:30 +0000 Subject: [PATCH] Create framework for Application Kit. git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@21851 a95241bf-73f2-0310-859d-f6bbb57e9c96 --- docs/user/Doxyfile | 2 ++ docs/user/app/_app_intro.dox | 40 ++++++++++++++++++++++++++++++++++++ docs/user/book.dox | 1 + 3 files changed, 43 insertions(+) create mode 100644 docs/user/app/_app_intro.dox diff --git a/docs/user/Doxyfile b/docs/user/Doxyfile index 79fafa6214..25e306162c 100644 --- a/docs/user/Doxyfile +++ b/docs/user/Doxyfile @@ -463,10 +463,12 @@ WARN_LOGFILE = # with spaces. INPUT = . \ + app \ drivers \ midi \ midi2 \ support \ + ../../headers/os/app \ ../../headers/os/drivers/fs_interface.h \ ../../headers/os/drivers/USB3.h \ ../../headers/os/drivers/USB_spec.h \ diff --git a/docs/user/app/_app_intro.dox b/docs/user/app/_app_intro.dox new file mode 100644 index 0000000000..4000a94cd1 --- /dev/null +++ b/docs/user/app/_app_intro.dox @@ -0,0 +1,40 @@ +/* + * Copyright 2007, Haiku, Inc. All Rights Reserved. + * Distributed under the terms of the MIT License. + * + * Documentation by: + * Niels Sascha Reedijk + */ + + +/*! + \page app_intro Introduction to the Application Kit. + + The Application Kit is a kit you will have to get to know in case you + want to effectively write Haiku applications with a GUI. The application + kit does exactly as the name might inform you: it is the basis for Haiku + applications. It is advised to read through this document, and the + documents referenced before going to any other part of the API. + + We can divide the classes in the application kit up in two categories. The + biggest part of the classes are in the 'messaging' classes. The following + are part of it: + - BHandler + - BInvoker + - BLooper + - BMessage + - BMessageFilter + - BMessageQueue + - BMessageRUnner + - BMessenger + + The second category is the 'system interaction' category. These classes + provides hooks for you application to interact with the rest of the system. + The most important class is BApplication. This is a list of all the + classes: + - BApplication + - BClipboard + - BCursor + - BPropertyInfo + - BRoster +*/ \ No newline at end of file diff --git a/docs/user/book.dox b/docs/user/book.dox index 65db84c0dc..ccd13a42d8 100644 --- a/docs/user/book.dox +++ b/docs/user/book.dox @@ -3,6 +3,7 @@ \section kits Kits and Servers + - \ref app | \link app_intro \em Introduction \endlink - \ref drivers - \ref midi1 - \ref midi2 | \link midi2_intro \em Introduction \endlink