Commit Graph

462 Commits

Author SHA1 Message Date
Przemysław Buczkowski 46cf7a5a73 Fix typos: super block -> superblock (#8974)
Signed-off-by: Przemysław Buczkowski <przemub@yahoo.pl>
Signed-off-by: Matt Madia <mattmadia@gmail.com>
2012-12-09 08:47:46 -05:00
Ithamar R. Adema 0f16abe379 Update todo notes 2012-11-22 21:30:54 +01:00
Niels Sascha Reedijk 2df12e67c1 Sync userguide from i18n.haiku-os.org. 2012-11-15 22:36:54 +01:00
Ithamar R. Adema 6645e68bb0 ARM: add todo note about VM implementation
Signed-off-by: Ithamar R. Adema <ithamar@upgrade-android.com>
2012-11-13 12:12:23 +01:00
Humdinger d3f77ddee3 Added correct flags for Hungarian and Brazilian.
+alpha4 (just in case its rebuild...)
2012-11-08 20:05:45 +01:00
Rene Gollent 2862f14d68 Added todo list.
Lists missing/incomplete Debugger features. Not exhaustive.
2012-11-07 23:18:23 +01:00
Ithamar R. Adema b0cef9d956 ARM/docs: add a TODO with the major open issues for this port.
Personally I find KDL hangman the biggest blocker, but oh well...
2012-11-07 17:20:47 +01:00
Ithamar R. Adema 9f512d6188 document architectural limitations of ARM port
Sure there are more, but this is at least a start for now ;)
2012-11-07 17:05:18 +01:00
François Revol 7c0097cb42 Even some more FDT/OF refs... 2012-11-06 20:14:55 +01:00
François Revol 6d8c8c0b32 Even more FDT references 2012-11-06 10:59:58 +01:00
François Revol f8e10024ad Some more FDT references 2012-11-06 10:39:23 +01:00
François Revol bc61f38130 Add some ARM references
* Actually stuff about FDT for now, also useful for other arch like PPC.
2012-11-06 10:33:07 +01:00
François Revol 35ef01c566 m68k: Add some atari references to the port docs 2012-11-05 20:58:04 +01:00
François Revol a6e7fd728d m68k: Add some references to the port docs 2012-11-05 20:50:12 +01:00
François Revol c2ee0abbc1 m68k: Remove one thing done from the TODO list 2012-11-05 20:50:12 +01:00
Niels Sascha Reedijk 5bde1d438b Update userguide from i18n.haiku-os.org. 2012-08-18 10:28:04 +02:00
Niels Sascha Reedijk 4b140bad0d Update the BString documentation.
* Remove the reference to BString::fPrivateData, as it currently really
   is marked as private and as such disappeared from the docs.
 * Add the various character methods that have been added in the
   previous revisions.
2012-05-12 11:54:07 +02:00
Oliver Tappe 546208a539 More catalog-related cleanup.
* rename B_TRANSLATE_CONTEXT to B_TRANSLATION_CONTEXT and
  B_TRANSLATE_WITH_CONTEXT to B_TRANSLATE_CONTEXT, squashing a TODO
* adjust all uses of both macros in Haiku's source tree
* use correct header guard for collecting/Catalog.h

The renamed macros require adjustments to all external applications
using catalogs.
2012-04-16 21:31:22 +02:00
John Scipione 12c10314f9 Remove MimeType docs from MimeType.cpp and cleanup style issues in that file. Create a MimeType.dox file and add the docs there. 2012-03-18 00:09:53 -04:00
Niels Sascha Reedijk b39e687949 Update welcome pages from i18n.haiku-os.org 2012-02-17 20:39:23 +01:00
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