[haiku-doc] Re: suggested changes for _app_intro.dox

 Hi, folks

I have included a few suggestions to make this a little more readable,
and to spiffy-up the grammar. Feel free to use as you think best. My
suggestions are in red, with explanations where appropriate.

Secondly, I haven't been able to actually open a document in Doxygen as
yet. I'm using the gui version and I believe I have all the necessary
programs. Is there an special order for beginning the tasks? I can't
remember exactly what I did; it was about a year ago.

\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.
+    The Application Kit is the first kit you will have to get to know if
you
Perhaps "The Application Kit should be your starting point, if you want
to ...."
+    want to write native Haiku applications with a GUI. The application
kit does
+    exactly as its name suggests:
Picky, I know, but this should be a semi-colon; you have joined two
complete sentences (like this one)
 it is the basis for Haiku    applications.  You
+    should read through this document and the documents referenced
here    before
+    moving on 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. Have a
look at
-    the \link app_messaging Introduction to Messaging \endlink for more
-    information. The following classes are part of it:
+    The Application Kit classes can be divided into two groups:
(The colon is correct here; the second part is not a full sentence.)
the "messaging"
+    classes and the "system interaction" classes.  The largest
larger  (there are only two groups: "largest" means three or more groups.
 group contains
+    the messaging classes. Have a look at the \link app_messaging
+    Introduction to Messaging \endlink for more information.
+    The following classes are messaging classes:
- BHandler
- BInvoker
- BLooper
@@ -29,13 +30,13 @@
- 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 second group is the system interaction classes. These classes
+    provide hooks for your application to interact with the rest of the
system.
The most important class is BApplication. This is a list of all the
-    classes:
+    system interaction classes:
- BApplication
- BClipboard
- BCursor
- BPropertyInfo
- BRoster
-*/
\ No newline at end of file
+*/

Thanks, Tim; I liked your changes.

Bob Colwell

-- 
Be Yourself @ mail.com!
Choose From 200+ Email Addresses
Get a Free Account at www.mail.com

Other related posts: