Commit Graph

20 Commits

Author SHA1 Message Date
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
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
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
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
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
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
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
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
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
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