Commit Graph

592 Commits

Author SHA1 Message Date
John Scipione
c258d2fa0e Fill out BFont member docs 2013-01-19 13:17:47 -05:00
John Scipione
566e828c5f Add initial BFont documentation 2013-01-19 13:17:46 -05:00
John Scipione
c45e8003d3 Update font size of memberdoc tables from 13px to 14.4px 2013-01-17 18:13:05 -05:00
John Scipione
4aae53f373 Update Haiku Book CSS
* Update headers to match User Guide better for font and spacing.
* 14.4px is the default font size (matching user guide).
* because we use em's for page width this makes the text area a bit narrower.
* Make note, warning, stop, remark notifications font size smaller to make
  them stand out a bit less and better matches the User Guide.
2013-01-16 12:44:22 -05:00
John Scipione
5e6540723d Update BFilePanel docs, especially detailed description and constructor 2013-01-15 23:07:12 -05:00
François Revol
7daaf25d9c Merge branch 'master' into sam460ex 2013-01-15 07:09:10 +01:00
John Scipione
2b934bb6ae Add BFilePanel and BRefFilter documentation 2013-01-14 23:31:18 -05:00
John Scipione
ea468b9855 Add \brief tag so description appears in files table 2013-01-14 21:11:15 -05:00
John Scipione
0abbcaaa35 Update Doxyfile to 1.7.5.1 2013-01-14 20:33:50 -05:00
François Revol
0ccce7886f Merge branch 'master' into sam460ex 2012-12-27 15:50:06 +01:00
John Scipione
93ebe7637f Update BDurationFormat docs. Came for warnings, ended up fixing more. 2012-12-24 19:55:26 -05:00
John Scipione
89dfe27fc8 Update BCatalog docs to fix warnings and update.
Especially listing the status codes is useful. Some style fixes and
update \li to -.
2012-12-24 19:07:56 -05:00
John Scipione
495275e4ea Add BFileInterface class documentation 2012-12-24 18:36:55 -05:00
John Scipione
c8654dba73 Minor updates to BFileGameSound docs 2012-12-24 18:31:08 -05:00
John Scipione
939600d2ad Update SetPaused() and add IsPaused() documentation 2012-12-24 16:05:51 -05:00
John Scipione
05c71c9699 Add BFileGameSound class documentation 2012-12-24 15:42:48 -05:00
François Revol
be95f65a23 Merge branch 'master' into sam460ex 2012-12-24 01:52:39 +01:00
John Scipione
e1988c7d53 Reduce font size of code blocks to 13px 2012-12-23 12:05:03 -05:00
John Scipione
e9191cc2d1 Add BFile documentation to the Haiku Book.
Remove the documentation from the cpp file also. Keep the brief
description as a regular comment though.
2012-12-22 15:01:17 -05:00
John Scipione
8e7094494a Fix another warning in MimeType.dox along with some 80 char fixes 2012-12-22 15:01:17 -05:00
John Scipione
268177055e Fix 2 warnings in MimeType.dox 2012-12-21 22:51:19 -05:00
John Scipione
f729cb8d48 Remove methods from CheckBox.dox that are not unique to the class fixing warnings 2012-12-21 22:51:19 -05:00
John Scipione
177942adc7 Remove documentation fro Button.dox that is not unique to BButton fixing a few warnings 2012-12-21 22:51:18 -05:00
John Scipione
e5f2a41917 Update revision, this matters because I changed the variables in the BDragger constructor. 2012-12-21 22:34:27 -05:00
John Scipione
a6ada82b00 Add BDragger class documentation 2012-12-21 22:31:29 -05:00
John Scipione
ceaf7141fa BDirectWindow class documentation fixes 2012-12-21 21:01:40 -05:00
John Scipione
b1b809ef27 Add preliminary DirectWindow documentation 2012-12-21 20:38:18 -05:00
John Scipione
746abcb938 Add BCursor class documentation 2012-12-21 18:26:29 -05:00
François Revol
0e4a0c0e7f sam460ex: one more address in the notes 2012-12-19 16:08:49 +01:00
François Revol
6ccf5f95c0 sam460ex: add port notes (org-mode format) 2012-12-19 15:34:23 +01:00
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
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
Jonas Sundström
7485fe842b Typo correction.
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@40722 a95241bf-73f2-0310-859d-f6bbb57e9c96
2011-02-27 11:17:18 +00:00
Philippe Houdoin
7f08510a9a Better to have consistent paths...
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@40550 a95241bf-73f2-0310-859d-f6bbb57e9c96
2011-02-18 12:32:18 +00:00
Philippe Houdoin
a7e6888c00 Updated to reflect actual paths these days.
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@40549 a95241bf-73f2-0310-859d-f6bbb57e9c96
2011-02-18 12:08:31 +00:00
Alex Wilson
7e8daebe34 Fix a few typos in Locale kit documentation.
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@40521 a95241bf-73f2-0310-859d-f6bbb57e9c96
2011-02-15 20:26:52 +00:00
Joachim Seemer
9639885450 Update to user guide. A few new pages and many translations by Google Code-In students. ShowImage, MediaPlayer and WebPositive are not yet ready for translation. Thanks everyone.
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@40044 a95241bf-73f2-0310-859d-f6bbb57e9c96
2010-12-30 19:10:45 +00:00
Matt Madia
2c9a0aae32 Added some updates to hey documentation, for 1.2.6 --> 1.2.8 changes.
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@39737 a95241bf-73f2-0310-859d-f6bbb57e9c96
2010-12-05 13:05:17 +00:00
Matt Madia
b0a8d13338 Move icon_guidelines/ to docs/.
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@39730 a95241bf-73f2-0310-859d-f6bbb57e9c96
2010-12-04 20:18:59 +00:00
Joachim Seemer
bcbc6fda31 Updated user guide.
* Added Maciej Baluta's GCI work on NetworkStatus, PowerStatus and
  ProcessController with only minor changes.
* Created a page for Daniel Marth's GCI work, based on the wiki page at
  https://dev.haiku-os.org/wiki/SystemBinCommands
* Updated translations mostly for Japanese and Italian from the currently 
  running GCI tasks.

Thanks everyone!


git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@39724 a95241bf-73f2-0310-859d-f6bbb57e9c96
2010-12-04 19:04:43 +00:00
Adrien Destugues
15352f8de6 Fix missing \fn.
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@39706 a95241bf-73f2-0310-859d-f6bbb57e9c96
2010-12-02 18:40:15 +00:00
Adrien Destugues
01c2a7f38f Some inprovements suggested by Stippi and tqh. Thanks!
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@39697 a95241bf-73f2-0310-859d-f6bbb57e9c96
2010-12-01 20:12:28 +00:00
Adrien Destugues
2d14fc1b97 Major improvement to the support kit introduction, done as part of gci by InsDel (Thanks!).
Again, review welcome on this in order to decide if we carry on asking students to write api reference pages.


git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@39696 a95241bf-73f2-0310-859d-f6bbb57e9c96
2010-12-01 19:40:02 +00:00
Joachim Seemer
07df8bec9b Updated user guide and welcome page. Among it a new page on Web+ and translations done for Google Code-In. Thanks everyone.
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@39691 a95241bf-73f2-0310-859d-f6bbb57e9c96
2010-12-01 14:23:44 +00:00
Adrien Destugues
6ec25bba48 Add documentation for BBox class, done by Clark Gaebel as part of GCI 2010.
I did rework the text a little.

I would like to get some careful review for this. Nielx put out the (valid) concern that he's not confident in random students with no previous Haiku experience to write the API reference.
I'd like to know if I should put online more of these tasks, or if I should stop now because the quality is too low.


git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@39686 a95241bf-73f2-0310-859d-f6bbb57e9c96
2010-11-30 21:06:09 +00:00
Joachim Seemer
1adf49423b Updated user guide pages.
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@39577 a95241bf-73f2-0310-859d-f6bbb57e9c96
2010-11-22 19:42:54 +00:00
Joachim Seemer
b57206f658 Fixed erroneously reversed translations. Looks like one always has to export the complete dataset from the translation site instead of just the changed sets ATM. Thanks Vincent for the tip.
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@39167 a95241bf-73f2-0310-859d-f6bbb57e9c96
2010-10-28 08:57:17 +00:00
Joachim Seemer
c585624fa4 Update of userguide\welcome page. Thanks translators.
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@39164 a95241bf-73f2-0310-859d-f6bbb57e9c96
2010-10-27 15:47:37 +00:00
Alex Wilson
cc19e7c0ff 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
2010-10-23 02:33:08 +00:00
Alex Wilson
a46d62a268 Fix some typos in archiving documentation.
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@39054 a95241bf-73f2-0310-859d-f6bbb57e9c96
2010-10-23 01:51:37 +00:00
Oliver Tappe
b0c3ed0447 * fix a couple of typos
* removed a sentence that's no longer true

git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@39024 a95241bf-73f2-0310-859d-f6bbb57e9c96
2010-10-20 17:32:29 +00:00
Oliver Tappe
6f43fabafb * some cleanup in BLocaleRoster
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@39018 a95241bf-73f2-0310-859d-f6bbb57e9c96
2010-10-20 09:23:06 +00:00
Joachim Seemer
534a3a24cd Updating userguide and welcome page and their translations. Thanks everyone.
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@38690 a95241bf-73f2-0310-859d-f6bbb57e9c96
2010-09-17 13:28:39 +00:00
Adrien Destugues
0d858bd391 Add documentation for the BTimeZone class.
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@38130 a95241bf-73f2-0310-859d-f6bbb57e9c96
2010-08-16 07:23:42 +00:00
Alex Wilson
886c23bf8b Update doxygen docs for recent changes to BArchivable, also document the BArchiver and BUnarchiver classes, and add a not in compatibility.dox.
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@38035 a95241bf-73f2-0310-859d-f6bbb57e9c96
2010-08-11 22:09:14 +00:00
Joachim Seemer
834e58f9b7 Update of user guide and welcome page and their translations.
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@38032 a95241bf-73f2-0310-859d-f6bbb57e9c96
2010-08-11 17:56:45 +00:00
Adrien Destugues
7ea3a2b029 Add note about the fact that locale kit is not part of libbe
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@38020 a95241bf-73f2-0310-859d-f6bbb57e9c96
2010-08-11 12:39:29 +00:00
Adrien Destugues
a8a3468a80 * Add documentation for the UnicodeChar class.
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@38018 a95241bf-73f2-0310-859d-f6bbb57e9c96
2010-08-11 12:33:47 +00:00
Axel Dörfler
4bfbfb4da5 * Corrected compatibility note. I wonder why I share my wisdom on the public
mailing list if I am then asked to do the work myself ;-)


git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@38016 a95241bf-73f2-0310-859d-f6bbb57e9c96
2010-08-11 12:00:47 +00:00
Adrien Destugues
cae874d384 * Lots of fixes and proofreading to the locale api reference
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@38010 a95241bf-73f2-0310-859d-f6bbb57e9c96
2010-08-11 08:09:12 +00:00
Adrien Destugues
e82e8f365e * Update locale kit documentation.
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@38004 a95241bf-73f2-0310-859d-f6bbb57e9c96
2010-08-10 12:39:48 +00:00
Adrien Destugues
3290008f1e * Add the warning and info boxes from userguide. However, I don't know how to upload the associated images to the api
server.


git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@37981 a95241bf-73f2-0310-859d-f6bbb57e9c96
2010-08-09 08:46:16 +00:00
Adrien Destugues
4db75e5128 * Fix typo pointed out by umccoullough. I should get a real keyboard.
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@37977 a95241bf-73f2-0310-859d-f6bbb57e9c96
2010-08-08 17:29:32 +00:00
Adrien Destugues
e579ff38fb * Added a note about the network libraries being incompatible with BeOS.
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@37976 a95241bf-73f2-0310-859d-f6bbb57e9c96
2010-08-08 16:20:09 +00:00
Adrien Destugues
5393193d0a * Fix some typos in the API reference for BLocale and BCatalog.
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@37950 a95241bf-73f2-0310-859d-f6bbb57e9c96
2010-08-07 14:08:05 +00:00
Adrien Destugues
0a4e27c50b * 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
2010-08-05 12:09:20 +00:00
Adrien Destugues
c6247544ed * 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
2010-08-04 12:01:38 +00:00
Adrien Destugues
e9fd63ec7c * Fix some outdated information in documentation files
* Add a very small part of documentation about the Locale Kit.


git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@37873 a95241bf-73f2-0310-859d-f6bbb57e9c96
2010-08-03 16:02:55 +00:00
Joachim Seemer
7bff797f8a Updated user guide.
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@37849 a95241bf-73f2-0310-859d-f6bbb57e9c96
2010-08-02 16:51:09 +00:00
Joachim Seemer
facb1eb9ad Update of the user guide and its translations.
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@37659 a95241bf-73f2-0310-859d-f6bbb57e9c96
2010-07-21 15:52:50 +00:00
Ingo Weinhold
1a38616f35 Fixed fs_vnode_ops::create() documentation: The function shall not fail, if
the file already exists, unless O_EXCL has been specified. At least that's
how our file systems with write support implement it.


git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@37554 a95241bf-73f2-0310-859d-f6bbb57e9c96
2010-07-17 16:00:48 +00:00
Ingo Weinhold
1f23605dd7 Added description for fs_volume_ops::get_vnode()'s _type and _flags
parameters.


git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@37552 a95241bf-73f2-0310-859d-f6bbb57e9c96
2010-07-17 15:39:39 +00:00
Philippe Houdoin
18d844d2d9 Long forgotten update about the new vector icon added to midi endpoint under Haiku.
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@37528 a95241bf-73f2-0310-859d-f6bbb57e9c96
2010-07-15 18:34:25 +00:00
Joachim Seemer
ad5e743e2b Update to user guide and welcome page. Introducing Portuguese and Chinese. Thanks to all translators\!
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@37435 a95241bf-73f2-0310-859d-f6bbb57e9c96
2010-07-08 18:03:41 +00:00
Matt Madia
508f54795f Patch by Karvjorm : updates DiskUsage to XHTML Transistional. Fixes #6204.
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@37410 a95241bf-73f2-0310-859d-f6bbb57e9c96
2010-07-06 02:17:43 +00:00
Matt Madia
6c4ac6b0b1 The User Guide and Welcome now contain their own copies of images/.
* deleted the non-used docs/images/
 * updated the optional package Welcome accordingly


git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@37036 a95241bf-73f2-0310-859d-f6bbb57e9c96
2010-06-06 16:38:37 +00:00
Joachim Seemer
2376416a94 The updated welcome package with all translations. Thanks everyone.
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@36782 a95241bf-73f2-0310-859d-f6bbb57e9c96
2010-05-09 15:52:37 +00:00
Joachim Seemer
0517ce048e The updated user guide with all translations. Thanks everyone.
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@36781 a95241bf-73f2-0310-859d-f6bbb57e9c96
2010-05-09 15:51:27 +00:00
Joachim Seemer
3636190576 Latest Welcome package changes for luroh's proof reading :)
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@36615 a95241bf-73f2-0310-859d-f6bbb57e9c96
2010-05-04 18:32:21 +00:00
Joachim Seemer
1cae99d78e Updated welcome page. Thanks to all translators.
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@36309 a95241bf-73f2-0310-859d-f6bbb57e9c96
2010-04-15 18:02:06 +00:00
Joachim Seemer
71b14067a1 Updated userguide. Thanks to all translators.
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@36308 a95241bf-73f2-0310-859d-f6bbb57e9c96
2010-04-15 18:01:21 +00:00
Philippe Houdoin
24957bd499 Fixed last places where resolv.conf was still expected under /etc, UserGuide included. Fixed authentication misspelling
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@35898 a95241bf-73f2-0310-859d-f6bbb57e9c96
2010-03-18 08:48:13 +00:00