Commit Graph

442 Commits

Author SHA1 Message Date
Niels Sascha Reedijk
4ac8d3e9e4 Update userguide from i18n.haiku-os.org 2012-01-31 11:50:22 +01:00
Niels Sascha Reedijk
c9d16a1694 Update the userguide from i18n.haiku-os.org 2012-01-02 08:17:34 +01:00
Niels Sascha Reedijk
646c788ab6 Update documentation from i18n.haiku-os.org 2012-01-02 08:16:11 +01:00
John Scipione
f969ed4153 A few formatting tweaks in the BEntry and BDirectory class documentation. 2011-12-18 21:43:22 -05:00
John Scipione
d4fa97f8f8 Moved documentation for the BEntry class into a dox file to include it into the Haiku book. 2011-12-18 21:28:55 -05:00
John Scipione
a92e17b124 Fix copyright line to Haiku, Inc. in Directory.dox and a few more small fixes. 2011-12-18 21:26:02 -05:00
John Scipione
38f6a824d2 Fix copyright line to Haiku, Inc. in GameProducer.dox 2011-12-18 21:25:31 -05:00
John Scipione
8786818cf2 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.
2011-12-18 19:42:33 -05:00
John Scipione
2ac1eb67b3 Move the doxygen documentation comments from src/kits/storage/Directory.cpp to docs/user/storage/Directory.dox and update it both the language, fix a few errors, and bring the syntax up to snuff. The documentation for the BDirectory class is now added to the Haiku Book. 2011-12-18 18:53:46 -05:00
Alex Wilson
a84e14ca84 Merge branch 'master' of git://github.com/haiku/haiku 2011-12-15 20:50:28 -07:00
Alexander von Gluck IV
157046ce4b Fix spelling mistake in user doc 2011-12-12 13:47:05 -06:00
Peter Polacik
8f03c411b0 A makefile/Jamfile engines How To added
* This document was written during GCI 2011
  by Peter Poláčik and is explaining how to use
  makefile and Jamfile engines to start and
  setup new development projects for Haiku.

Signed-off-by: Siarzhuk Zharski <zharik@gmx.li>
2011-12-10 08:31:18 +01:00
Alex Wilson
8f0b7c3fb8 Update doxygen docs for Layout, LayoutItem on invalidation. 2011-12-06 23:39:16 -07:00
Niels Sascha Reedijk
e6f22646a3 Update userguide and welcome documentation with the latest additions and translations from i18n.haiku-os.org. 2011-12-03 21:12:53 +01:00
John Scipione
2231cbd5fe Replace the US_PC_keyboard_keycodes.png image in the Keyboard special topic of the Haiku book with an optomized version saving over 100k. 2011-11-18 15:59:41 -05:00
François Revol
345c3b6c39 Some pointers about porting to iPaq devices since I have one now 2011-11-17 15:07:36 +01:00
François Revol
478dc9887e PPC: Preliminary untested boot support for Common Firmware Environment
CFE is used in the upcoming Amiga X-1000 dualcore PPC board.
* Largely inspired by the OF and U-Boot code.
* Still largely stubbed out.
* The loader builds but I don't have a machine to test it. Anyone interested?
2011-11-14 01:31:50 +01:00
Adrien Destugues
5caae4d450 Fix documentation of Collator: Greater and GreaterOrEqual are not commutative (that would mean Greater(s1, s2) is the same as
Greater(s2, s1), and adding a negation in front of them is not enough either.


git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@43233 a95241bf-73f2-0310-859d-f6bbb57e9c96
2011-11-11 09:19:19 +00:00
John Scipione
f69cadd0e9 Update the BCollator class documentation to fix a number of spelling errors and make the text clearer and easier to read. Also add a bunch of details, a few warnings and notes and other small typographical changes.
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@43232 a95241bf-73f2-0310-859d-f6bbb57e9c96
2011-11-11 03:55:09 +00:00
John Scipione
a2547dba0e A few updates and corrections to the new Keyboard page in the Haiku Book. I hope I got this in time before the next scheduled build of the Haiku Book.
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@43231 a95241bf-73f2-0310-859d-f6bbb57e9c96
2011-11-11 02:38:48 +00:00
John Scipione
4466b89c65 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
2011-11-10 08:35:38 +00:00
François Revol
561696cbfc TODO list for the m68k port, for when I fix the kernel build.
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@43113 a95241bf-73f2-0310-859d-f6bbb57e9c96
2011-11-02 14:51:15 +00:00
John Scipione
38a0577422 Set SORT_MEMBERS_CTORS_1ST variable to YES in the Doxyfile so that constructor and destructor methods will get sorted before member methods in class documentation files.
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@43099 a95241bf-73f2-0310-859d-f6bbb57e9c96
2011-11-02 09:17:38 +00:00
John Scipione
90a55c448a Copy paste mistype, B_WEEKDAY_FRIDAY instead of B_WEEKDAY_THURSDAY twice.
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@43097 a95241bf-73f2-0310-859d-f6bbb57e9c96
2011-11-02 08:40:28 +00:00
John Scipione
6ac7032dc6 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
2011-11-02 08:36:02 +00:00
John Scipione
740ae7fef6 Return B_ERROR if a locking error occurs in while locking the BLocale object, return B_BAD_VALUE if an ICU error occurs or the passed in value is NULL. Update BLocale API documentation to reflect this and also add some more documentation fixes. Closes #7901 pending confirmation.
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@43095 a95241bf-73f2-0310-859d-f6bbb57e9c96
2011-11-02 06:02:36 +00:00
Niels Sascha Reedijk
7f1880dc0e 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
2011-10-29 22:02:52 +00:00
Niels Sascha Reedijk
1326b9d0b4 Apply the patch by jscipione on ticket #7994.
* Update BScreen class style and variable names
 * Remove documentation from Screen.cpp file
 * Create Screen.dox documentation file



git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@42984 a95241bf-73f2-0310-859d-f6bbb57e9c96
2011-10-29 21:51:43 +00:00
Adrien Destugues
c647837666 * Add some details on how the Locale and the formater classes relate and which
one one should use.
 * Add documentation for BDurationFormat.


git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@42976 a95241bf-73f2-0310-859d-f6bbb57e9c96
2011-10-29 19:56:05 +00:00
François Revol
1ff3981e26 PPC Mac related links for porting.
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@42938 a95241bf-73f2-0310-859d-f6bbb57e9c96
2011-10-28 23:20:20 +00:00
Alex Wilson
7ab5610ba9 Update layout docs for LayoutInvalidated() changes. 2011-10-28 14:17:02 -06:00
Alex Wilson
4e0131f51b Rename BLayout::DerivedLayoutItems() to DoLayout(), which is consistent with BView::DoLayout(). Also adjusted child classes and documentation. 2011-10-28 14:16:25 -06:00
Alex Wilson
676c618ad7 Add a little info to the BLayout docs. 2011-10-28 14:16:22 -06:00
François Revol
3c6f4dd82e A description of the Atari TOS PRG file format I used to write the ldscript for the .prg bootloader at src/system/ldscripts/m68k/boot_prg_atari_m68k.ld
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@42927 a95241bf-73f2-0310-859d-f6bbb57e9c96
2011-10-26 23:55:00 +00:00
Adrien Destugues
fd4f34da56 Remove extra parameter to function call in documentation.
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@42859 a95241bf-73f2-0310-859d-f6bbb57e9c96
2011-10-16 10:02:10 +00:00
Adrien Destugues
68eccf0d5c The description for frameMoved and FrameResized was wrong. Thank Skipp_OSX for noticing.
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@42695 a95241bf-73f2-0310-859d-f6bbb57e9c96
2011-08-27 19:41:09 +00:00
Adrien Destugues
07658a130e Add some documentation for find_directory. This is very incomplete yet.
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@42694 a95241bf-73f2-0310-859d-f6bbb57e9c96
2011-08-27 09:15:50 +00:00
Adrien Destugues
d51bfbb57c Patch by John Scipione again : fix the new BIconUtils documentation.
thanks!


git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@42609 a95241bf-73f2-0310-859d-f6bbb57e9c96
2011-08-09 21:57:31 +00:00
Adrien Destugues
a33f8fbdec 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
2011-08-09 21:46:13 +00:00
Adrien Destugues
61a02f6d99 * Add the header file to doxygen, too
* Fix copypaste error.


git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@42607 a95241bf-73f2-0310-859d-f6bbb57e9c96
2011-08-09 19:39:10 +00:00
Adrien Destugues
ca2c99c2ca * Add BIconUtils documentation to the Haiku Book
* Remove comments from the header itself.


git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@42606 a95241bf-73f2-0310-859d-f6bbb57e9c96
2011-08-09 19:31:46 +00:00
Joachim Seemer
fac7d59322 Added a page on Mail and a little workshop so people can have a look and suggest improvements before putting it into the online tool. Which still has the problem of broken image upload and export of all pages...
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@42603 a95241bf-73f2-0310-859d-f6bbb57e9c96
2011-08-09 16:40:03 +00:00
Joachim Seemer
7660ac681c Update user guide and welcome pages and their translations. Thanks everyone. +alpha
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@42127 a95241bf-73f2-0310-859d-f6bbb57e9c96
2011-06-12 18:03:25 +00:00
Joachim Seemer
402f023740 Updated userguide and welcome pages. Thanks all translators. +alpha3
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@41971 a95241bf-73f2-0310-859d-f6bbb57e9c96
2011-06-06 16:08:15 +00:00
Joachim Seemer
cbe53dacb8 Added Chinese and Russian flags. Fixes #7566. Thanks taos for noticing.
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@41716 a95241bf-73f2-0310-859d-f6bbb57e9c96
2011-05-24 18:02:15 +00:00
Joachim Seemer
fed577d81d Updated user guide plus translations. Thanks everyone. +alpha3
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@41656 a95241bf-73f2-0310-859d-f6bbb57e9c96
2011-05-22 18:01:43 +00:00
Niels Sascha Reedijk
3d2b623f71 Update the header to reflect the height of the logo image, which is 84px instead of 86px. See the discussion on r41337 on haiku-commits.
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@41362 a95241bf-73f2-0310-859d-f6bbb57e9c96
2011-05-07 08:09:57 +00:00
Joachim Seemer
36883d1e5b Fixing some typos, found by John Scipione and some by myself.
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@41361 a95241bf-73f2-0310-859d-f6bbb57e9c96
2011-05-07 05:58:20 +00:00
Matt Madia
fa0af37702 Updated the HAIKU logo to display the registered trademark symbol.
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@41337 a95241bf-73f2-0310-859d-f6bbb57e9c96
2011-05-06 00:01:40 +00:00
Joachim Seemer
897e2f47ef Manually updated pages from the translation site. Mostly to have the work of the GCI students in SVN history, as I already have a few reworked pages locally which I'd like to put on the translation site.
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@40889 a95241bf-73f2-0310-859d-f6bbb57e9c96
2011-03-09 17:03:28 +00:00