Commit Graph

160 Commits

Author SHA1 Message Date
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
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
Alex Wilson 8f0b7c3fb8 Update doxygen docs for Layout, LayoutItem on invalidation. 2011-12-06 23:39:16 -07: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
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
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
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
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
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
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
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
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
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
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