Commit Graph

62 Commits

Author SHA1 Message Date
John Scipione 46f5821ad1 Add docs for BOutlineListView class 2013-12-11 16:15:15 -05:00
John Scipione 853f724631 Minor updates to BListView docs 2013-12-11 16:13:12 -05:00
John Scipione 7192a9313e Add documenation for BPopUpMenu class 2013-11-11 19:28:04 -05:00
John Scipione 24be9ac7fd Update SetRadioMode() method to descibe radio mode 2013-11-11 19:27:13 -05:00
John Scipione 0096a29e9c Add BMenuField class documentation 2013-11-08 19:29:13 -05:00
John Scipione d7d2ff5bde Minor updates to the BMenu and BMenuBar classes.
Remove the reimplemented hook methods groups because some
hook methods are there, some are not, unfortunately doxygen can’t
tell if a hook method just calls the default or does something else and
we tend to include all the hook methods even if we don’t actually make
any functional changes to them making the docs a bit more verbose
than they otherwise would be.
2013-11-08 19:29:13 -05:00
John Scipione a676c40c3e Some minor updates to BControl docs. 2013-11-08 19:29:12 -05:00
John Scipione 8b4655091d More minor updates to the BView docs. 2013-11-08 19:29:12 -05:00
John Scipione 34ce2cefc8 BMenuBar docs, silly mistake 2013-11-06 19:35:01 -05:00
John Scipione ed7c19b5ef Added BMenuBar docs. 2013-11-06 19:26:34 -05:00
John Scipione 0d635255f5 Minor updates to BMenu docs.
Added an Archive() method description.
2013-11-06 19:23:48 -05:00
John Scipione 45e17d3d42 Update BView::DrawAfterChildren() param name
... from r to updateRect, no functional change intended.

Also a tiny change to the param description in the docs.
2013-11-06 13:14:53 -05:00
John Scipione 2f746eafdc Add BMenu documentation 2013-11-06 12:21:58 -05:00
John Scipione 45b87db2b7 A few minor updates to the BView docs 2013-11-06 12:21:57 -05:00
John Scipione 31005da9b8 Update BWindow shortcut docs 2013-10-20 15:51:34 -04:00
Adrien Destugues 6ec9625a36 Fix mismatched prototypes in the Haiku Book. 2013-10-04 16:56:59 +02:00
John Scipione e9eb899aa4 BFont docs: Update SetEncoding() with some new info 2013-08-25 21:36:50 -04:00
John Scipione f59d62ffd3 Add BWindow documentation 2013-07-26 18:36:17 -04:00
John Scipione 080bf8fe19 Fix rest of warnings, doxygen now runs cleanly.
The BTextView::SetText() methods were included twice, update the first and
remove the second.
2013-07-08 19:30:45 -04:00
John Scipione e724b26f23 Remove enum elaborated type specifier
...from orientation params. Elaborated type specifiers are not needed
for C++ code and removing them makes doxygen happy. Verified working
on both gcc2h and gcc4h builds.
2013-07-08 19:29:11 -04:00
John Scipione 27929dcd1d BView docs: Add remaining new method descriptions
Layout and Tool Tip method documentation.

Also ScrollWithMouseWheelDelta()
2013-06-28 23:18:55 -04:00
John Scipione 468559e46d Update BView docs for changes in hrev45799 2013-06-28 23:12:38 -04:00
John Scipione dd84193fa4 Begin filling out the detailed description 2013-06-28 20:28:45 -04:00
John Scipione 1126023668 Fill out the constructor docs. 2013-06-28 20:28:43 -04:00
John Scipione 2891821fde Fill out the BView docs
* Fill out the Input related method descriptions and also some other updates
  to method and variable descriptions.
* Document Graphics State Methods and a bunch of Drawing Related Methods
* Add a bunch more drawing method descriptions.
* Fill out the rest of the methods of the BView class.
2013-06-28 20:28:32 -04:00
John Scipione 8fc951cebb BFont docs: Clarify escapement_delta language.
Make it clear that the values provided by the escapement_delta struct are an
input to App Server which allows the user to specify extra horizontal space around each character and is not an output provided by App Server.
2013-06-13 14:35:03 -04:00
John Scipione 4cbcabff5f Add documentation for BListView and BListItem classes 2013-04-25 17:58:13 -04:00
John Scipione 2d5697e109 A few fixes to TextView.dox, \see BView::method() 2013-04-25 17:57:35 -04:00
John Scipione d58ff0b187 Add BTextView class docs 2013-03-16 17:22:56 -04:00
John Scipione ca9a59bbc5 add a newline 2013-03-16 17:04:44 -04:00
John Scipione 131261d2b5 Remove remaining /trunk/ before file references. 2013-02-07 21:19:06 -05:00
John Scipione a93a16151d Fix doxygen warnings, enums can only be in 1 group 2013-02-07 15:52:07 -05:00
John Scipione 820dca4df6 Big docs cleanup.
* Fixed headers including:
  - All rights reserved not All Rights Reserved.
  - name, email@domain.com not name <email@domain.com>
  - tabs and spaces
  - Authors: not Documented by:
* Renamed string.dox to String.dox
* Renamed midixxx.dox files to MidiXxx.dox
* Moved images into images subdirectories and updated Doxfile.
* Re-format all files with tabs instead of spaces.
* Fix many spelling mistakes.
* Added all files, classes, structs, and enums to libbe group.
2013-02-07 02:01:19 -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 ea468b9855 Add \brief tag so description appears in files table 2013-01-14 21:11:15 -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
Alex Wilson a84e14ca84 Merge branch 'master' of git://github.com/haiku/haiku 2011-12-15 20:50:28 -07:00
Alex Wilson 8f0b7c3fb8 Update doxygen docs for Layout, LayoutItem on invalidation. 2011-12-06 23:39:16 -07: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 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
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