History log of /haiku-fatelf/docs/user/book.dox
Revision Date Author Comments
# 3528f5bb 19-Jan-2013 John Scipione <jscipione@gmail.com>

Add BBitmapStream docs and translation kit stub


# 8786818c 18-Dec-2011 John Scipione <jscipione@gmail.com>

Add documentation for the GameProducer class in the Game Kit.

This documentation was provided by Omri Barak, a student participating
in Google Code Initiative (GCI) 2011.

Signed off by John Scipione

Since this is the first class documented in the Game Kit I also added
a reference to the Game Kit to the API docs front page.


# 4466b89c 10-Nov-2011 John Scipione <jscipione@gmail.com>

Add a section to the Haiku Book with a very special topic, the keyboard.
This started off as just being a page to detail the key codes since I find
myself constantly referencing the BeBook page on the subject and it is
horribly broken. However, the page has grown to detail many of the keyboard
related methods and constants defined in InterfaceDefs.h as well. A very
long and detailed explanation of the key_map structure is included.

git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@43230 a95241bf-73f2-0310-859d-f6bbb57e9c96


# 6ac7032d 02-Nov-2011 John Scipione <jscipione@gmail.com>

Update the style of the Haiku Book to resemble the User Guide.
If you have never seen this before you are in for a bit of a shock.
Update the Doxyfile to 1.7.3 (the version that gets auto-generated).

Update the book.dox front page with some nice introductory text.

Add new documentation for the following classes:
BCheckBox
BClipboard
BColorControl
BControl
BEntryList
BView (preliminary)

Remove redundant documentation from src/kits/storage/EntryList.cpp

Minor documentation update for the following classes:
BAlert
BApplication
BArchivable
BBox
BButton
BCatalog
BFindDirectory
BHandler
BUnarchiver
BString

git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@43096 a95241bf-73f2-0310-859d-f6bbb57e9c96


# 7f1880dc 29-Oct-2011 Niels Sascha Reedijk <niels.reedijk@gmail.com>

Apply patch for ticket #8008:
* Remove BNode documentation from the source code and add it to Node.dox
* Rewrite some of the existing documents


git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@42986 a95241bf-73f2-0310-859d-f6bbb57e9c96


# a33f8fbd 09-Aug-2011 Adrien Destugues <pulkomandy@pulkomandy.ath.cx>

Merge work by John Scipione on the Haiku Book.
* Some new classes documented
* Screenshots for the interface kit controls
* A lot of typo fixes
* Some css tweaks

This has some backporting to the current version of Doxygen, since
there are experiments to get coloring similar to the one in the Be
Book that will hopefully be upstreamed in Doxygen.


git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@42608 a95241bf-73f2-0310-859d-f6bbb57e9c96


# cc19e7c0 22-Oct-2010 Alex Wilson <yourpalal2@gmail.com>

Add initial documentation for Layout API, not everything is documented, and it's not perfect, but its time to commit this.


git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@39055 a95241bf-73f2-0310-859d-f6bbb57e9c96


# 0a4e27c5 04-Aug-2010 Adrien Destugues <pulkomandy@pulkomandy.ath.cx>

* Fixed the main page entry for locale kit
* Also parse the actual code to get the methods shown in the classes, inheritance diagrams, and all that stuff
* Add some docs on date formatting to BLocale


git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@37925 a95241bf-73f2-0310-859d-f6bbb57e9c96


# c6247544 03-Aug-2010 Adrien Destugues <pulkomandy@pulkomandy.ath.cx>

* Add the locale kit to the main page
* Complete and correct some parts of locale and catalog classes reference
* Ensure the methods are prefixed with the class name so doxygen knows where they belong.


git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@37898 a95241bf-73f2-0310-859d-f6bbb57e9c96


# 8a446182 08-Aug-2007 Niels Sascha Reedijk <niels.reedijk@gmail.com>

Create framework for Application Kit.

git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@21851 a95241bf-73f2-0310-859d-f6bbb57e9c96


# bef614ef 23-May-2007 Niels Sascha Reedijk <niels.reedijk@gmail.com>

Add Credits to the Haiku Book.

git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@21217 a95241bf-73f2-0310-859d-f6bbb57e9c96


# 3458a335 03-Apr-2007 Ingo Weinhold <ingo_weinhold@gmx.de>

Started documenting the FS API a bit.


git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@20544 a95241bf-73f2-0310-859d-f6bbb57e9c96


# 9889ca4a 02-Apr-2007 Niels Sascha Reedijk <niels.reedijk@gmail.com>

* book.dox Reformat according to the guidelines
* BufferIO.dox Reformat according to the guidelines
* DataIO.dox Reformat according to the guidelines
* Flattenable.dox New documentation.
* Locker.dox Finished documentation.
* SupportDefs.dox Reformat according to the guidelines

git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@20511 a95241bf-73f2-0310-859d-f6bbb57e9c96


# 89e18a51 02-Mar-2007 Niels Sascha Reedijk <niels.reedijk@gmail.com>

* Take a document on compatibility from the Haiku website (experimenting with pages) - Originally written by Ingo and updated by others, I have permission from Ingo.
* book.dox Rework a bit of the structure
* midi2/support Separate the overview (or Introduction) from the list of elements in a module.
* support Wrote initial documentation for Beep/BufferIO/DataIO
* Stub for article on archiving.

git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@20307 a95241bf-73f2-0310-859d-f6bbb57e9c96


# 9d54b143 26-Feb-2007 Niels Sascha Reedijk <niels.reedijk@gmail.com>

* Add documentation for BAutolock, BBlockCache and BList
* Finish up documentation for BString
* Trying to work a bit more on the structure.

git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@20236 a95241bf-73f2-0310-859d-f6bbb57e9c96


# d419ca3b 11-Sep-2006 Niels Sascha Reedijk <niels.reedijk@gmail.com>

Update API documentation and Doxyfile to improve the output.

git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@18822 a95241bf-73f2-0310-859d-f6bbb57e9c96


# ec15a3e1 14-Mar-2005 Axel Dörfler <axeld@pinc-software.de>

Added the support kit to the docs (doesn't seem to be maintained these days,
but won't harm either).


git-svn-id: file:///srv/svn/repos/haiku/trunk/current@11733 a95241bf-73f2-0310-859d-f6bbb57e9c96


# 700c9b5d 01-Jun-2004 Waldemar Kornewald <wkornew@nowhere.fake>

Added initial PPP API documentation.


git-svn-id: file:///srv/svn/repos/haiku/trunk/current@7729 a95241bf-73f2-0310-859d-f6bbb57e9c96


# 0524a6a8 11-Mar-2003 mahlzeit <mahlzeit@nowhere.fake>

Added Midi Kit end-user documentation.


git-svn-id: file:///srv/svn/repos/haiku/trunk/current@2881 a95241bf-73f2-0310-859d-f6bbb57e9c96


# 8786818cf2b7afd3ea9979f06d3ead55cfef041b 18-Dec-2011 John Scipione <jscipione@gmail.com>

Add documentation for the GameProducer class in the Game Kit.

This documentation was provided by Omri Barak, a student participating
in Google Code Initiative (GCI) 2011.

Signed off by John Scipione

Since this is the first class documented in the Game Kit I also added
a reference to the Game Kit to the API docs front page.


# 4466b89c65970de4c7236ac87faa2bee4589f413 10-Nov-2011 John Scipione <jscipione@gmail.com>

Add a section to the Haiku Book with a very special topic, the keyboard.
This started off as just being a page to detail the key codes since I find
myself constantly referencing the BeBook page on the subject and it is
horribly broken. However, the page has grown to detail many of the keyboard
related methods and constants defined in InterfaceDefs.h as well. A very
long and detailed explanation of the key_map structure is included.

git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@43230 a95241bf-73f2-0310-859d-f6bbb57e9c96


# 6ac7032dc66744139522bdef3fab49d4e894a84a 02-Nov-2011 John Scipione <jscipione@gmail.com>

Update the style of the Haiku Book to resemble the User Guide.
If you have never seen this before you are in for a bit of a shock.
Update the Doxyfile to 1.7.3 (the version that gets auto-generated).

Update the book.dox front page with some nice introductory text.

Add new documentation for the following classes:
BCheckBox
BClipboard
BColorControl
BControl
BEntryList
BView (preliminary)

Remove redundant documentation from src/kits/storage/EntryList.cpp

Minor documentation update for the following classes:
BAlert
BApplication
BArchivable
BBox
BButton
BCatalog
BFindDirectory
BHandler
BUnarchiver
BString

git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@43096 a95241bf-73f2-0310-859d-f6bbb57e9c96


# 7f1880dc0ed378e10f46bf7dd6d697dcf9ffd9fe 29-Oct-2011 Niels Sascha Reedijk <niels.reedijk@gmail.com>

Apply patch for ticket #8008:
* Remove BNode documentation from the source code and add it to Node.dox
* Rewrite some of the existing documents


git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@42986 a95241bf-73f2-0310-859d-f6bbb57e9c96


# a33f8fbdec035ff322cc1ef364877a3092e99a09 09-Aug-2011 Adrien Destugues <pulkomandy@pulkomandy.ath.cx>

Merge work by John Scipione on the Haiku Book.
* Some new classes documented
* Screenshots for the interface kit controls
* A lot of typo fixes
* Some css tweaks

This has some backporting to the current version of Doxygen, since
there are experiments to get coloring similar to the one in the Be
Book that will hopefully be upstreamed in Doxygen.


git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@42608 a95241bf-73f2-0310-859d-f6bbb57e9c96


# cc19e7c0ffc8b52c397d854c894193b3e69c022b 22-Oct-2010 Alex Wilson <yourpalal2@gmail.com>

Add initial documentation for Layout API, not everything is documented, and it's not perfect, but its time to commit this.


git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@39055 a95241bf-73f2-0310-859d-f6bbb57e9c96


# 0a4e27c50bf15b9ebf5831513c1a598acf8e0516 04-Aug-2010 Adrien Destugues <pulkomandy@pulkomandy.ath.cx>

* Fixed the main page entry for locale kit
* Also parse the actual code to get the methods shown in the classes, inheritance diagrams, and all that stuff
* Add some docs on date formatting to BLocale


git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@37925 a95241bf-73f2-0310-859d-f6bbb57e9c96


# c6247544ed97094ea79c89fe41db6562b2c1eba7 03-Aug-2010 Adrien Destugues <pulkomandy@pulkomandy.ath.cx>

* Add the locale kit to the main page
* Complete and correct some parts of locale and catalog classes reference
* Ensure the methods are prefixed with the class name so doxygen knows where they belong.


git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@37898 a95241bf-73f2-0310-859d-f6bbb57e9c96


# 8a446182252e58e75cbe8d2fb715abfc1fc8f9ad 08-Aug-2007 Niels Sascha Reedijk <niels.reedijk@gmail.com>

Create framework for Application Kit.

git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@21851 a95241bf-73f2-0310-859d-f6bbb57e9c96


# bef614ef092e3a7686bacd5b9c7f526e41cd390f 23-May-2007 Niels Sascha Reedijk <niels.reedijk@gmail.com>

Add Credits to the Haiku Book.

git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@21217 a95241bf-73f2-0310-859d-f6bbb57e9c96


# 3458a335ab23b6fc6d280d721a6a15b08b11fcb4 03-Apr-2007 Ingo Weinhold <ingo_weinhold@gmx.de>

Started documenting the FS API a bit.


git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@20544 a95241bf-73f2-0310-859d-f6bbb57e9c96


# 9889ca4a68133cf86c7c72afce0fb251294e5d67 02-Apr-2007 Niels Sascha Reedijk <niels.reedijk@gmail.com>

* book.dox Reformat according to the guidelines
* BufferIO.dox Reformat according to the guidelines
* DataIO.dox Reformat according to the guidelines
* Flattenable.dox New documentation.
* Locker.dox Finished documentation.
* SupportDefs.dox Reformat according to the guidelines

git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@20511 a95241bf-73f2-0310-859d-f6bbb57e9c96


# 89e18a513c88a244eadb707a1a036d705692d16b 02-Mar-2007 Niels Sascha Reedijk <niels.reedijk@gmail.com>

* Take a document on compatibility from the Haiku website (experimenting with pages) - Originally written by Ingo and updated by others, I have permission from Ingo.
* book.dox Rework a bit of the structure
* midi2/support Separate the overview (or Introduction) from the list of elements in a module.
* support Wrote initial documentation for Beep/BufferIO/DataIO
* Stub for article on archiving.

git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@20307 a95241bf-73f2-0310-859d-f6bbb57e9c96


# 9d54b143680303b7aff0fbfd2e03f4ebab291c8e 26-Feb-2007 Niels Sascha Reedijk <niels.reedijk@gmail.com>

* Add documentation for BAutolock, BBlockCache and BList
* Finish up documentation for BString
* Trying to work a bit more on the structure.

git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@20236 a95241bf-73f2-0310-859d-f6bbb57e9c96


# d419ca3b7bf7e42c137fc3ea9b74eeaf7e653d49 11-Sep-2006 Niels Sascha Reedijk <niels.reedijk@gmail.com>

Update API documentation and Doxyfile to improve the output.

git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@18822 a95241bf-73f2-0310-859d-f6bbb57e9c96


# ec15a3e18f8ab8a75fb020d5d7157e89910a1dc9 14-Mar-2005 Axel Dörfler <axeld@pinc-software.de>

Added the support kit to the docs (doesn't seem to be maintained these days,
but won't harm either).


git-svn-id: file:///srv/svn/repos/haiku/trunk/current@11733 a95241bf-73f2-0310-859d-f6bbb57e9c96


# 700c9b5dad153bf7dd75286126ba276fdc9e2f44 01-Jun-2004 Waldemar Kornewald <wkornew@nowhere.fake>

Added initial PPP API documentation.


git-svn-id: file:///srv/svn/repos/haiku/trunk/current@7729 a95241bf-73f2-0310-859d-f6bbb57e9c96


# 0524a6a89db566881e3acf3cee9b39614d22a511 11-Mar-2003 mahlzeit <mahlzeit@nowhere.fake>

Added Midi Kit end-user documentation.


git-svn-id: file:///srv/svn/repos/haiku/trunk/current@2881 a95241bf-73f2-0310-859d-f6bbb57e9c96