John Scipione
90ae2e54f6
Update keycodes image with more stylish version
2013-01-21 20:10:59 -05:00
John Scipione
3528f5bb69
Add BBitmapStream docs and translation kit stub
2013-01-19 15:05:11 -05:00
John Scipione
6a4b222bc9
Use condensed, not squished together. Better
2013-01-19 13:17:50 -05:00
John Scipione
4f7717a999
By removing the style on escapement_delta doxygen links it up which is better
2013-01-19 13:17:49 -05:00
John Scipione
27c3eae9b4
Another minor fix, style constant
2013-01-19 13:17:49 -05:00
John Scipione
0d2b04ca83
Minor update use fixed font for B_OK
2013-01-19 13:17:49 -05:00
John Scipione
05757eb6b3
Fill out BFont detailed description.
...
Also a bunch of cleanup including removing private method docs
and cleaning up language. BFont is pretty much completely documented
at this point.
2013-01-19 13:17:48 -05:00
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
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
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
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
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