Commit Graph

771 Commits

Author SHA1 Message Date
Axel Dörfler 58fd8acd78 Added BLaunchRoster documentation.
* Untested, and could use some more love when it comes to possible
  error codes.
2015-07-22 20:45:38 +02:00
Augustin Cavalier 4d556706b5 docs/user: s/http:/https:/. 2015-07-21 18:24:37 -04:00
Augustin Cavalier 8868ca02ed docs/user: TabView: Fix erroneous descriptions of Select() and Deselect(). 2015-07-14 11:26:39 -04:00
John Scipione 0afa3a4850 BRoster docs: force be_roster to link, lang cleanup 2015-07-07 16:22:31 -07:00
John Scipione e8aeed6eef Fix BRoster::Launch documentation const mismatch 2015-07-07 16:22:29 -07:00
John Scipione 49a56113ef Fix typo: on => one 2015-07-07 16:22:27 -07:00
John Scipione 046d20afd1 BScrollView::ScrollBar return val docs past tense 2015-07-07 16:22:25 -07:00
John Scipione 5a2ed95c23 Clarify ScrollView::ScrollBar() direction parameter in docs 2015-07-07 16:22:23 -07:00
John Scipione c466b4daeb IK: Change orientation param name to direction
for ScrollView::ScrollBar in ScrollView.h and the documentation. This makes
the parameter name consisent and fixes a doxygen warning.
2015-07-07 16:22:22 -07:00
Augustin Cavalier 93c67e52f3 docs/user: Add/update some '\sa's. 2015-07-07 11:57:42 -04:00
Augustin Cavalier 0426b7e7e8 docs/user: Fix documentation of BTab::SetLabel. 2015-07-07 11:57:40 -04:00
Augustin Cavalier 896c0b7543 Move doc from src/kits/network to docs/net.
Thanks Adrien for reviewing!
2015-06-30 09:34:02 -04:00
Alexander G. M. Smith 143edb7460 docs: makefile-engine: add missing HTML tags.
Fixes #12063.

Signed-off-by: Augustin Cavalier <waddlesplash@gmail.com>
2015-06-01 18:28:17 -04:00
Michael Lotz 0bba9b9752 Fix some typos and whitespace in BLayout docs. 2015-04-15 00:30:55 +02:00
Augustin Cavalier 51362d85d8 Haiku Book: Doxyfile: eat __attribute__ directives.
Without this, Doxygen attempts to parse __attribute__ directives
and often outputs garbage instead of properly parsing them, so just
exclude them from the documentation.

Fixes some incorrect function listings in BString documentation
and possibly more elsewhere.
2015-04-06 18:00:39 -04:00
Augustin Cavalier 64f7e980a4 BString docs: don't have tags in hsection titles. 2015-04-06 17:51:04 -04:00
Augustin Cavalier 906283b6d6 Haiku Book: Make the layout introduction somewhat more professional. 2015-03-25 11:47:29 -04:00
Augustin Cavalier 9d6780b587 Haiku Book: disable class diagrams.
The last time this was discussed on the ML, the consensus was that
the text lists were nicer than the diagrams (with only one objection).
For the minority that wants class diagrams, it's easy enough to reverse
this one-line change.
2015-03-25 11:37:10 -04:00
Augustin Cavalier e6ecb3fc07 Haiku Book: Midi2 fixes.
* Automatic whitespace cleanup.
 * Removed all of Midi2 from the "libbe" group, as they aren't part of it
 * Get rid of the redundant "libmidi2" group, as all of midi2 is already in
   the "MIDI 2 Kit" group, and the docs explicitly state that the MIDI 2 Kit
   has its own library.
2015-03-25 11:30:01 -04:00
Augustin Cavalier aa6ef6658c Haiku Book: fix device drivers group definition.
Also removed the "Keyboard" group definition, which was broken. There
wasn't anything in that group, and there's only one page on the
keyboard anyway.
2015-03-25 11:23:51 -04:00
Alexander von Gluck IV 9f76848eca doc/rpi1: Fix old reference to old FDT blob 2015-03-07 16:52:43 -06:00
Alexander von Gluck IV 1ac3785a72 doc: Update rpi1/rpi2 documentation. 2015-03-07 16:50:51 -06:00
Augustin Cavalier c86c9e29d3 ScrollView docs: make parameter name match the header file. 2015-02-27 02:39:07 -05:00
autonielx f3f0969580 Update userguide translations 2015-02-23 18:29:56 +01:00
Augustin Cavalier cf76c29456 interface_guidelines: add a convert.sh script that uses XMLTO.
Works on Linux, doesn't work on Haiku. It appears xsltproc tries
to fetch the DTD and XSL stylesheets (which doesn't work, for some reason
it wasn't built with HTTP support, and I can't figure out why). Even
when telling it to use the preinstalled XSL & DTDs using --catalog,
it still tries to download the files...
2015-02-13 11:26:28 -05:00
Augustin Cavalier 7d6915b4d0 Interface Guidelines: migrate to docs/, use DocBookCSS.
DocBookCSS is a mostly-pure-CSS2 implementation of the DocBook standard.
Unlike DocBookXSL which relies on transforming the XML, it utilizes the
XML-styling features of modern web browsers to display the DocBook.

Its appearance still is a long way from the Haiku Book and Userguide, but
it looks (mostly) the same as the old DocBookXSL so we can stop using that.
Eventually we just need to make DocBookCSS use our styling.
2015-02-12 17:08:04 -05:00
Augustin Cavalier 644fa5a938 src/documentation: delete the old HaikuUserGuide.txt.
Written by DarkWyrm, this user guide has been long since superseded by
the new HTML-based User Guide, which has everything this did and then
some, with the exception of the "History" section. That section
does seem like it could be useful somewhere, so I've moved it to
its own file in the "docs/misc" directory.
2015-02-12 10:37:22 -05:00
Augustin Cavalier 32fab80eea Revert "Delete old DiskUsage docs."
Apparently, upon reading the "fine print" at the bottom, these docs *must*
be distributed with the binaries.

Now to try to contact the author...
2015-02-11 22:02:24 -05:00
Augustin Cavalier 4cb2c39774 Haiku Book: compatibility: list all authors at the top of the file as per convention.
All of the other .dox files here list authors at the top of the file
in a standard (non-Doxygen) comment, so do the same here.

I've listed the file as copyright 2011, as (according to Git) that's
the last time it was functionally changed. I also added a few people
in as being authors of the file who seem to have made significant
changes to it.
2015-02-11 19:14:20 -05: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
Augustin Cavalier 82d26eb239 Haiku Book: old Midi Kit: fix link to the BeBook.
That online copy of the BeBook went offline some time ago, and we
now host one, so point to that instead.
2015-02-11 19:00:18 -05:00
Augustin Cavalier 22440f4105 Delete old DiskUsage docs.
The DiskUsage docs in the Userguide have all of this info and then
some.
2015-02-11 18:44:29 -05:00
John Scipione b1a9f638da Add preliminary Net Kit intro by Philippe Houdoin
From here:
http://philippe.houdoin.free.fr/phil/beos/openbeos/network_kit/overview.html
2015-01-27 19:16:54 -05:00
John Scipione d04b3b772c Remove trailing . from titles 2015-01-27 19:15:11 -05:00
John Scipione 7177815b20 Use regular bullets for lists, matches User Guide 2015-01-27 19:14:36 -05:00
John Scipione 3cf6e692c8 Fix typos in BReferencable docs 2015-01-27 18:17:16 -05:00
Adrien Destugues f6c0340128 Add documentation for BReference and BReferenceable. 2015-01-26 13:59:55 +01:00
John Scipione a82d6bdd3e Replace 'should' with 'must' in BInvoker::SendMessage() docs 2015-01-22 13:43:45 -05:00
John Scipione a66de90c49 Clarify BInvoker::SetMessage() docs some more
The language on SetMessage() was still a bit confusing, this should
hopefully clear it up.
2015-01-20 20:13:57 -05:00
autonielx ba483af7de Update userguide translations 2015-01-17 18:26:48 +01:00
Adrien Destugues 412f030b0f Some clarifications to BInvoker docs. 2015-01-17 13:41:55 +01:00
John Scipione db7ef1292a Add BMessageRunner docs 2015-01-16 18:00:50 -05:00
John Scipione 2eb2dcfabe Small fixes to BMessenger docs 2015-01-16 17:59:48 -05:00
John Scipione fd3c25a928 Move the operator function docs over too 2015-01-16 16:43:34 -05:00
John Scipione 973984649c Add BMessenger docs 2015-01-16 16:43:33 -05:00
John Scipione 19ce061e0b Update BInvoker docs to clarify them
...with notes from PulkoMandy and Axel. Also added author credits.

Class documentation is moved to the appropriate method and then \sa
is used to point to the documentation so it is only documented in
one location.

Added some text about how the interaction between BInvoker and
BHandler and/or BLooper works.

BMessenger needs to be documented to understand how SetTimeout() is
suppose to work, refer to BeBook for now.
2015-01-16 14:24:32 -05:00
John Scipione 23f1ce0756 BInvoker::Timeout was introduced in BeOS R5, not R3 2015-01-15 15:33:27 -05:00
John Scipione 9bf7584d96 Add BInvoker docs 2015-01-15 15:30:23 -05:00
Adrien Destugues c50131cd6a Complete and rework BJoystick docs. 2015-01-10 11:44:58 +01:00
mandar c8e6696716 Add documentation for the Open method in the joystick class. 2015-01-10 11:31:02 +01:00