Commit Graph

19 Commits

Author SHA1 Message Date
Augustin Cavalier
93c67e52f3 docs/user: Add/update some '\sa's. 2015-07-07 11:57:42 -04:00
Augustin Cavalier
aa01bfe571 Haiku Book: fix some typos.
The possessive form of "it" is "its", not "it's" ("it's" is just
shorthand for "it is").

Closes #11712.
2015-02-11 19:04:38 -05:00
John Scipione
95faf2ce54 Minor doc changes 2014-12-18 20:45:25 -05:00
John Scipione
459706ee4d Update BView and BStringView docs
... based on Adrien's suggestions.

* Add \warning back to BView::ResizeToPreferred(), add \remark to highlight
  methods only appropriate to use as part of a BLayout.
* Clarify BView::SetFont() method and refer to BFont docs.
* Clarify BStringView::SetText(), Text(), and Draw().
* add field descriptions for BStringView::Instantiate().
2014-12-05 20:35:40 -05:00
John Scipione
13c789f6c0 A few updates to the BView docs (needed for BStringView) 2014-12-04 17:56:53 -05:00
John Scipione
47852bff02 IK documentation update
* Add \since directive to each method.
* Add documentation for BScrollBar and BScrollView classes.
* Title Case group titles.
* Some other minor documentation updates.
2014-06-13 17:44:22 -04:00
Adrien Destugues
f31bb74725 ConstrainClippingRegion does not transform.
Document the fact that the region-based clipping does not use the view
transform. Also hint to a way to constrain drawing to a transformed
region.
2014-06-02 14:55:23 +02:00
John Scipione
9c244999df Update BView docs, especially MouseMoved() 2014-05-28 12:14:43 -04:00
John Scipione
8c2c52ff67 BView docs: move description up, few updates. 2014-05-28 12:14:09 -04:00
John Scipione
8b4655091d More minor updates to the BView docs. 2013-11-08 19:29:12 -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
45b87db2b7 A few minor updates to the BView docs 2013-11-06 12:21:57 -05: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
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
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