Commit Graph

1041 Commits

Author SHA1 Message Date
Augustin Cavalier
414b21c497 docs/user: Fix description of bigtime_t. 2018-12-14 18:59:17 -05:00
Adrien Destugues
151343ebc8 BLooper: API to hijack existing thread.
I need this to use loopers in WebKit, which spawns threads and expects
to be able to turn them into event loops later on.

This is the pattern already used in BApplication, we may as well make it
available elsewhere.

Change-Id: I5939ca89d33cb3bcc92567b302c2038d976af598
Reviewed-on: https://review.haiku-os.org/735
Reviewed-by: Axel Dörfler <axeld@pinc-software.de>
Reviewed-by: waddlesplash <waddlesplash@gmail.com>
2018-12-02 21:36:31 +00:00
Adrien Destugues
e4425315dd Proofread and update the HIG
- Use neutral they to make the user (and in one instance, the
  'stereotypical lazy developer') gender neutral. Thanks to hacker news
  commenters for raising the issue.
- Various updates and clarifications on cursors (not restricted to black
  and white anymore), toolbars & about boxes (we now have a standard
  implementation for them), zooming (exemple more strongly showing that
  it should be "fit to contents" especially on modern high resolution
  displays)
- Reword english in some places

Change-Id: Ic8a392665c08e5186a1fb8aa95e4b741862a8dd7
Reviewed-on: https://review.haiku-os.org/681
Reviewed-by: waddlesplash <waddlesplash@gmail.com>
2018-11-09 21:43:21 +00:00
Adrien Destugues
d02879c185 HIG: rewrap
This will ease managing the doc and reviewing upcoming changes.
2018-11-09 20:48:44 +01:00
Axel Dörfler
efafab643c Deskbar: Resizable tray
* Adds max width and height arguments to
  instantiate_deskbar_(item|entry).
* Old applications just stay with a 16x16 scaled icon, though.
* All used apps within the repository are converted to the new call
  besides the input_server input method icon (that will need further
  API changes in the input_server).

Change-Id: I29cc439396917be2c24135888459d31364997dff
Reviewed-on: https://review.haiku-os.org/656
Reviewed-by: waddlesplash <waddlesplash@gmail.com>
2018-11-04 19:00:49 +00:00
Autocommitter
7852aa0525 Update userguide translations
Also purge old documents
2018-10-20 16:28:58 -04:00
waddlesplash
6f415a4a02 Update userguide and welcome pages.
This is the first userguide export on the Postgres-based translation tool
(previously it used MySQL), so please double-check it extra carefully.
(I spotted a few minor problems in the export and fixed the relevant
bugs already.)
2018-09-26 01:46:30 -04:00
François Revol
8865af3950 BApplication docs: fix example
Fixes #14520.
2018-09-24 19:30:05 +02:00
Augustin Cavalier
c3ac0a72a6 BMenuItem: Remove ourselves from the super menu on destruct.
This fixes the (intermittently) crashing test added in the previous commit,
and should also fix #12024 and #14348.

Note that this is a slight behavioral departure from BeOS, though since
BeOS crashed when this was done previously, it shouldn't cause any
other problems.

Change-Id: I90b6132ff7741b8d6cb601375a9b11fc3ffacb40
Reviewed-on: https://review.haiku-os.org/541
Reviewed-by: waddlesplash <waddlesplash@gmail.com>
2018-09-12 01:15:48 +00:00
Adrien Destugues
03e5dd5273 Fix documentation for BMessage::Previous
The function allocates a message because it uses lazy initialization,
however the user does not get ownership and must not delete it.

Fixes #14413.
2018-08-28 19:14:57 +02:00
Augustin Cavalier
99158ccedd makefile-engine docs: Fix app_name_catalog_entry.
Fixes #14392.
2018-08-25 21:22:54 -04:00
Augustin Cavalier
63cb446249 docs/user: Remove extra comment opener.
It made the second one show up in the documentation.
2018-08-15 14:09:07 -04:00
Augustin Cavalier
f2015c2f81 boot/platform/cfe: Remove, unused.
All platforms it was theoretically useful for also have U-Boot.
OK'd by mmu_man.
2018-08-11 20:21:12 -04:00
krish_iyer
0ea0138965 SDHCI MMC Driver Documentation
Change-Id: I4bbe302fabd21133a9c03b9e48a407db8afbc70e
Reviewed-on: https://review.haiku-os.org/452
Reviewed-by: Adrien Destugues <pulkomandy@gmail.com>
2018-08-10 12:08:35 +00:00
Leorize
91791df982 docs/develop/packages/TODO: add missing part
Sorry, apparently I was half-asleep and missed this part

Change-Id: I888a975ae7ff30d1039f466e63d37c30b94d3739
Reviewed-on: https://review.haiku-os.org/444
Reviewed-by: waddlesplash <waddlesplash@gmail.com>
2018-08-06 23:40:47 +00:00
Jérôme Duval
9a90ee3a38 Revert "Switch default fixed font from NotoMono to NotoSansMono"
This reverts commit b2acee1cb9.

Reason: NotoSansMono is not per se a fixed font.
2018-08-02 14:19:33 +02:00
Humdinger
b2acee1cb9 Switch default fixed font from NotoMono to NotoSansMono
Change-Id: Ib9eab5a2e266393b234cf7f4a6934fd58e31c943
Reviewed-on: https://review.haiku-os.org/48
Reviewed-by: waddlesplash <waddlesplash@gmail.com>
Reviewed-by: Jérôme Duval <jerome.duval@gmail.com>
2018-08-02 10:43:57 +00:00
Augustin Cavalier
b456e5d055 docs/develop/net: NetBSD has an official GitHub mirror now. 2018-08-01 18:23:15 -04:00
Humdinger
27dcc63210 Remove Fonts chapter from user guide
The fonts prefs were moved to the Appearance prefs a long time ago.
This page is a left-over, not referenced in the user guide anymore.
2018-07-16 16:48:09 +02:00
John Scipione
e79c33c93f BResources SetToImage docs: update variable name in retval (tiny) 2018-06-27 10:05:52 -07:00
Augustin Cavalier
61206a24c9 build: Cleanup of libgnuregex usage.
John's revert of my removal commit dragged back a bunch of cygwin/sunos
cruft, as well as re-adding RegExp.cpp to the host libshared, that we don't
need.

Instead, remove this and add libgnuregex_build to just the tools/keymap
link alongside the FreeBSD gnuregex case.
2018-03-07 18:04:31 -05:00
Leorize
03d384bbfb docs/develop/packages: convert wiki to rst
Cleaner syntax compared to MediaWiki, more features than Markdown, while
still looks good on plain text.
2018-03-03 20:22:46 +00:00
John Scipione
940a3a2322 Revert "build/libgnuregex: Remove."
This reverts commit ca087b0532.

Mac OS X requires libgnuregex for Keymap
2018-02-16 16:45:11 -08:00
Alexander G. M. Smith
f12d3b3477 Update BListItem::SetHeight() docs with selection box warning.
The cached top coordinate of each BListItem isn't updated when you
change the height of the item, leading to confusing highlighting and
incorrect mouse clicks.  Rather than fixing it, this just documents a
workaround or two to force an update of the cached coordinates.
2018-02-17 00:26:34 +00:00
Augustin Cavalier
e56d7050a3 docs/develop/packages: Update links and rename index.wiki to README.wiki.
Now this page is rendered when you open the directory on GitHub,
and you can use the links to open any of the files.
2018-01-10 16:54:32 -05:00
Augustin Cavalier
7a988ea15b docs/develop/packages: More fixes to syntax. 2018-01-10 16:48:08 -05:00
Augustin Cavalier
fc2b04e7e4 docs/develop/packages: Convert wiki files to MediaWiki syntax.
This is what GitHub actually is rendering pages as.
2018-01-10 16:37:28 -05:00
Augustin Cavalier
5492447a60 docs/develop: Migrate Package Management docs from Trac.
Still in Trac Wiki format (GitHub renders this well enough.)
2018-01-10 16:19:41 -05:00
Augustin Cavalier
42877d24cf makefile-engine.html: Does not belong in docs/develop.
docs/develop is for documentation about Haiku's internals. The Makefile-Engine
is public API. For now, put it in docs/misc.
2018-01-10 16:12:15 -05:00
Augustin Cavalier
e81a954787 docs/develop: Mass directory restructure.
Now vaguely follows the tree structure of "src", with the exception of
directories that described subsystems spanning more than one "kit" or
"server" (e.g. "media", "midi", "bluetooth") -- these have been left as their
own top-level directory within docs/develop.
2018-01-10 16:12:14 -05:00
Augustin Cavalier
cdf0ad6a80 docs/develop: Delete some more old/obsolete directories. 2018-01-10 16:12:14 -05:00
Augustin Cavalier
96efe3b3c0 docs/user: Migrate Axel's "Introduction to the Launch Daemon" from Trac. 2018-01-10 16:12:14 -05:00
Augustin Cavalier
4241437c83 docs/misc: Add BeIDE_ProjFileFormat.
This is the beginning of a large "move developer docs from the wiki
to the tree" operation, which will probably take some time to complete.

The general goal is to consolidate all docs that would be used by developers
(i.e., anyone working on the Haiku tree) into the tree itself. Docs on
getting started contributing, or for translators, designers, etc. will remain
on Trac and on the website.
2018-01-10 16:12:14 -05:00
Augustin Cavalier
97f4f2b559 Migrate the BTextMailComponent docs to the Haiku Book. 2017-12-26 13:59:25 -05:00
Augustin Cavalier
95c9effd68 Migrate the BMailComponent docs to the Haiku Book.
I've updated the docs to match the current BMailComponent, documented
new functions, and cleaned up the MailComponent.h file to at least
somewhat match our coding style.

First in a series (there are 3 more old API docs on the Mail Kit in that
"Public API" folder.)
2017-12-25 19:43:51 -05:00
Augustin Cavalier
cba277f2f9 docs/apps/mail: Extract the "Writing Add-ons" guide and convert to markdown.
I guess it was at one point in Be Styled Text format, but it didn't
extract that way for me, so I had to manually recreate the styling...
2017-12-25 17:15:21 -05:00
Augustin Cavalier
6602e4b755 hey: Delete old documentation.
Superseded by Humdinger's blog post, and the Hey tutorial
from the BeOS Bible.
2017-12-25 17:15:20 -05:00
Augustin Cavalier
ca087b0532 build/libgnuregex: Remove.
It was needed on macOS for a time when BUrl used regexes for parsing.
Now it does not, and so we can remove libshared's RegExp from build
libshared, and thus also libgnuregex.
2017-12-24 12:27:47 -05:00
Augustin Cavalier
d3b7157201 docs/develop: Remove obsolete "net" documents.
They've been "obsolete" since 2006, so they must be extra-obsolete
by now :-)
2017-12-20 20:42:57 -05:00
Augustin Cavalier
e7b5f0a6f7 docs/ikteam: Delete most files.
The Interface Kit is long since "99% functional", so lists of modules
with what's-implemented-what's-not are not really helpful anymore.

The one (rather lengthy) file describing the unit testing system
set up by the IKTeam is indeed useful, so keep that.
2017-12-20 20:28:57 -05:00
Augustin Cavalier
c42868a015 docs: Remove old "Mail Preferences" documentation.
Actually based on old BeOS documentation and long surpassed by
the Haiku User Guide.
2017-12-20 20:11:40 -05:00
Augustin Cavalier
6c179d73ad Icon Guidelines: Delete from tree, they live in the "website" repo now.
Previously when we used Drupal, the icon guidelines there "shadowed"
the ones in this tree. Now that the git-based website reigns supreme,
we should not keep two copies around. I've chosen to preserve
the one in the website repository and trash this one because the icon
guidelines primarily target artists, not programmers (as just about
all other docs in this directory do.)
2017-12-20 20:09:55 -05:00
Automatic Committer
5bdf48dea6 Update userguide and translations 2017-11-26 11:14:46 +01:00
Augustin Cavalier
f009c69deb docs/develop/input: Delete useless cruft.
The only thing of any real use in this directory was the Be Newsletter
article, and the objdump from BeOS R5 (at least I guess that's what it is...)
so I kept those.
2017-11-15 17:52:50 +01:00
John Scipione
1061001b46 API Docs: minor brief description updates 2017-11-10 15:24:34 -08:00
John Scipione
9e72aeccc5 LayoutBuilder docs: document missing paramters 2017-11-10 15:11:10 -08:00
John Scipione
a960a58cd7 Docs: remove ; causing it not to find copydetails 2017-11-10 15:00:05 -08:00
John Scipione
6f6c9e0069 BDurationFormat::Format docs, update method params
Also a tiny style fix in the header, put const qualifier
on same line
2017-11-10 14:59:33 -08:00
John Scipione
021c2fec4f BNumberFormat docs: remove const qualifier 2017-11-10 14:45:39 -08:00
John Scipione
e08fce49e7 BDurationFormat docs: update ctor docs 2017-11-10 14:41:28 -08:00
John Scipione
1e994bc7cf Docs: Fix some warnings
... by adding book_ prefix in front of section labels in book.dox
2017-11-10 14:17:55 -08:00
John Scipione
d4a640ec2e Replace pt0 and pt1 with start and end 2017-11-09 13:58:35 -08:00
John Scipione
44b874666a API docs: it's => its fix 2017-11-09 13:23:55 -08:00
Augustin Cavalier
83e8a2654c Revert "userguide: fixes link to repositories pref page."
Revert "docs: promote SoftwareUpdater as easy tool to update Haiku."

This reverts commit 6487273924.
This reverts commit 8aab3a0d5e.

--

The Userguide and Welcome Guide are written and managed in the Userguide
Translator, not in the tree.
2017-11-06 19:56:56 +01:00
Philippe Houdoin
6487273924 userguide: fixes link to repositories pref page. 2017-11-06 19:13:07 +01:00
Philippe Houdoin
8aab3a0d5e docs: promote SoftwareUpdater as easy tool to update Haiku.
The welcome page was still saying the only way to update Haiku
is per command line. Not as much welcoming as one could expect
since SoftwareUpdater is now available.

Add SoftwareUpdater to the list of Haiku's applications in User Guide.
2017-11-06 19:06:48 +01:00
Automatic Committer
64b20c9e12 Update userguide and translations
(note from waddlesplash: fixed xml:lang tags, responsive viewport
everywhere, CSS tweaks.)
2017-10-01 13:21:40 +02:00
Augustin Cavalier
9d5b0fdaa1 docs/user: Upgrade to Doxygen 1.8.13.
Also tweak the footer CSS a bit, and fix an unclosed comment in the
fs_interface docs (spotted via a warning in Doxygen output.)
2017-10-01 11:19:37 -04:00
Kacper Kasper
22423870a5 docs/user: Update CSS for Doxygen 1.8.12. 2017-09-30 17:26:46 +02:00
Akshay Agarwal
defdefa89a docs/user: Update locale kit description.
- Delete the introduction from the kits list page, as it is already
under locale_intro.
- Update the description in locale_intro.
- Since the locale kit now lives in libbe, delete the paragraph about
libraries from the intro, and move the still relevant part about
liblocalestub to the catalog translation macros description in
Catalog.dox.
2017-09-06 07:47:47 +02:00
Adrien Destugues
05d9795db3 Add some docs for BLayoutBuilder::Grid. 2017-08-13 09:05:29 +02:00
Adrien Destugues
a911a53fa6 HIG: Fix missing closing tag. 2017-08-07 18:05:58 +02:00
Humdinger
7c86c4573f Minor changes to interface guidelines
* Sentence casing for the examples of menus etc.
* Use elipses instead of "..."
* As originally proposed in ticket #5010 [1], we went with removing
  dynamic menu item labels, e.g. "Show grid" <-> "Hide grid" from
  our apps (ProcessController, Magnify, etc.)

 [1] https://dev.haiku-os.org/ticket/5010
2017-08-06 20:25:05 +02:00
Adrien Destugues
e433b3cfc3 DiskUsage docs: update screenshots.
- Why were we using old BeOS screenshots here?
- Why is this not part of the user guide anyways?
2017-07-22 11:30:52 +02:00
Augustin Cavalier
7aae2f7475 userguide: Actually sort the language menu. 2017-06-24 00:19:23 +02:00
Augustin Cavalier
b988c71571 Update userguide translations 2017-06-17 20:50:50 +02:00
Augustin Cavalier
0bb2d0ecad docs/user: Status codes are defined in Errors.h, not Error.h. 2017-06-14 18:05:31 -04:00
Adrien Destugues
a19a18f553 Rework BCollator API
- Strength is now set once, instead of at each comparison, to improve
  performance and fix potential locking issues
- Add a way to enable "numeric" collation (aka "natural order")
2017-05-29 08:52:43 +02:00
Andrew Lindesay
f943fa465c JSON Parser : Documentation migration
This commit migrates the JSON overview documentation that
was recently added from Markdown to Doxygen.
2017-05-26 21:05:14 +12:00
Andrew Lindesay
e6fa1be5fd Implementation of JSON Streaming Parser
Addition of missing files from previous commit
2017-05-13 19:35:51 +12:00
Alexander G. M. Smith
5e7964b0a9 Remove Spurious B_BEOS_DATA_DIRECTORY
There is no DATA directory in BeOS, and its FindDir() doesn't implement
it.  No need for a confusing backwards compatibility to something that
doesn't exist (had my hopes up, was going to move some non-executable
files from AddOns to Data in a program that works in BeOS and Haiku).

The removed enum label doesn't change the directory_which enum order
or count, as it was aliasing the value of another existing enum label
(B_SYSTEM_DATA_DIRECTORY).

Fixes #13470

Signed-off-by: Axel Dörfler <axeld@pinc-software.de>
2017-05-08 22:17:53 +02:00
luroh
a09b074d3e Cleanup app_server built-in fonts
We bundle bitstream charter as a default font to use when nothing else
is available. We also used to bundle a Courier font, but it does not
work properly.

- Fix the license for Bitstream Charter, to include just the license and
no extra text.
- Add said license to AboutSystem
- Remove the Courier font from the package and from the source tree.

Fixes #11696.
2017-04-30 13:55:36 +02:00
Augustin Cavalier
8dcdf72d72 Update userguide translations 2017-04-15 22:40:25 +02:00
Augustin Cavalier
b95e90657e docs/user: Update search URL following docs migration. 2017-04-15 16:28:06 -04:00
Humdinger
4135f1fd20 Update makefile-engine doc to v2.6
Grammar, formatting, updated paths etc.
2017-03-13 19:33:40 +01:00
John Scipione
1eed6ef172 BString docs: document IStartsWith() and IEndsWith() 2017-02-21 18:03:03 -08:00
Augustin Cavalier
7abafe9f3f Revert "Revert "Switch from DejaVu to Noto font""
This reverts commit 2423ba8470.
2017-02-19 12:09:33 -05:00
Augustin Cavalier
2423ba8470 Revert "Switch from DejaVu to Noto font"
This reverts commit 945566ff43.

As discussed on the mailing lists and with Humdinger off-list:
 * The general design concensus tends slightly towards DejaVu, as metrics
   of DejaVu look much better (DejaVu 12 and Noto 13 are roughly the same size,
   but Noto has much wider margins with that)
 * While Noto does have a wider set of fonts with support for lots of
   different languages, DejaVu actually has built-in support for more
   Unicode languages (the default Noto has, as far as I can tell, only
   Latin/Greek/Cyrillic [2416 glyphs], while DejaVu also has Armenian, Georgian,
   and a few other scripts too [5119 glyphs].)
 * The worse rendering of DejaVu appears to have been somewhat rectified by
   disabling the average-based subpixel filter in app_server.
2017-02-18 14:36:36 -05:00
Augustin Cavalier
b6f76ebe71 s/OpenBeOS License/MIT License/ universally, as they're the same thing.
Fixes #8681.
2017-02-09 22:09:56 -05:00
Augustin Cavalier
1de2d72812 Partially revert "ReadMe & docs: The Haiku Book has moved to www.haiku-os.org/docs/api."
This mostly reverts commit 75b219d35a.
The changes to the image URLs in Alert.dox are still needed, so I
didn't revert those.

As per discussion on the mailing list and IRC.
2017-02-01 15:23:54 -05:00
Augustin Cavalier
75b219d35a ReadMe & docs: The Haiku Book has moved to www.haiku-os.org/docs/api. 2017-02-01 11:22:01 -05:00
autonielx
7a3f3e0965 Update userguide translations, waddlesplash as nielx 2017-02-01 04:48:59 +01:00
Augustin Cavalier
92b020b5ea docs/user: Update infobox CSS to match the new colors. 2017-01-28 13:33:19 -05:00
Augustin Cavalier
44460faf4d docs/user: Make string literals in code blocks gray.
Class and function reference links are also blue, so this distinguishes
them from each other.
2017-01-28 13:26:20 -05:00
Augustin Cavalier
9dc2625de0 docs/user: Remove duplicate "ingroup interface" from layout docs.
Since the "Layout" group is a member of the "Interface" group,
Doxygen automatically adds the "Interface" group to all pages
in the "Layout" group, meaning that having an explicit "ingroup Interface"
created duplicate group tags.
2017-01-28 13:22:53 -05:00
Augustin Cavalier
3d7aa45e7a docs/user: Fix duplicate and erroneous BTabView class definition. 2017-01-28 13:19:14 -05:00
Augustin Cavalier
bd7dc5223f docs/user: Make more code blocks and the like appear in monospace fonts. 2017-01-28 13:17:41 -05:00
Augustin Cavalier
38e1208a75 docs/user: Add $projectname to the page title.
Doxygen used to add this to $title itself, but now it doesn't, so we
have to change our template.
2017-01-28 13:02:44 -05:00
Augustin Cavalier
8d38dd18f1 docs/user: Updates for Doxygen 1.8.
Surprisingly, after disabling the new Markdown support in the Doxyfile,
everything else pretty much worked out of the box. Only a number of CSS
changes were needed to adapt.

I wonder why nobody ever did this back in 2012 when 1.8 first came out...
2017-01-25 21:45:42 -05:00
Dario Casalinuovo
41acdd1d90 media_kit: Move some files and headers under docs/develop/media 2017-01-16 22:53:44 +01:00
John Scipione
c574ad267d Haiku Book: Make wider matching Userguide
I like the narrower width better, but, templates are too wide to fit.

See for example:
https://api.haiku-os.org/classBLayoutBuilder_1_1Group.html#abc185e5d9c43241664889b3b7f8df641
2017-01-06 16:10:29 -08:00
Humdinger
4d23ea8e81 Fix css for userguide and welcome page 2017-01-02 19:21:03 +01:00
John Scipione
e1304871bb Revert "BWindow: CenterOnScreen a bit above center"
This reverts commit a5be1832cc.
2017-01-01 12:25:05 -08:00
John Scipione
a5be1832cc BWindow: CenterOnScreen a bit above center
BWindow docs: Document changes to CenterOnScreen()

https://68.media.tumblr.com/d8dff7a17b9d90b41e32c5a2a0312513/tumblr_oj2wg1tmKs1r0f0hfo1_1280.png

Will revert if not appreciated.
2016-12-31 18:06:55 -08:00
Humdinger
945566ff43 Switch from DejaVu to Noto font
As discussed, Noto renders much better with freetype 2.7 [1].
The DejaVu package is still in the HaikuPorts repo and can be installed
manually just like all the other available fonts.

[1] http://www.freelists.org/post/haiku-development/freetype-update-from-265-to-27
2016-11-27 19:04:26 +01:00
Augustin Cavalier
87534026de docs/develop: Create a 'bluetooth' directory.
Presently contains only oco's final blogpost, for posterity's sake.
2016-10-19 19:18:14 -04:00
Andrew Lindesay
fa2dd9c45f BPackageInfo::Parser: Validate URL strings.
Fixes #12710.

Signed-off-by: Augustin Cavalier <waddlesplash@gmail.com>
I fixed the modifications to the Jamfiles in src/bin, they were all wrong
in the patch.
2016-06-18 18:40:07 -04:00
autonielx
9c59cb0692 Update userguide translations, leavengood as nielx 2016-05-06 20:48:02 +02:00
autonielx
b98538a5b5 Remove duplicate welcome and userguide directories 2016-05-06 20:28:17 +02:00
autonielx
bd3f6a54ec Update userguide translations, leavengood as nielx 2016-05-06 04:15:13 +02:00
John Scipione
57c4212174 LaunchRoster docs: Add warning not to use class
...as it is not yet finalized.
2016-04-29 15:51:32 -07:00
John Scipione
b5665b7243 AbstractSocket docs: Document reuseAddr param of Bind() 2016-04-29 15:43:45 -07:00
John Scipione
24cb14bc3d BTabView: Style fixes
Fix misleading indentation

remove extra newline

just a newline

selTabRect => selectedTabRect
2016-04-29 14:31:31 -07:00
John Scipione
3490eda827 ControlLook: Rename border param to borderStyle
border vs. borders is confusing.

BTabView: Rename border param to borderStyle

BTabView docs: rename border param to borderStyle

enumerate border styles in docs
2016-04-29 14:31:05 -07:00
John Scipione
4d52d1a8ca Add BPropertyInfo class docs 2016-04-27 11:10:34 -07:00
John Scipione
686b774894 LaunchRoster: doment data param to quiet warning 2016-04-27 11:10:32 -07:00
John Scipione
b855c871b7 Add private app headers to Doxyfile
needed for LaunchRoster which has gone private.
2016-04-27 11:10:32 -07:00
John Scipione
9a243c1b2a Fix errors in fs_interface.dox 2016-04-27 11:10:31 -07:00
John Scipione
873cc5542e Message docs: fix errors 2016-04-27 11:10:31 -07:00
John Scipione
c5fe2948ba BColorControl docs: pointer style
(really minor change that doesn't affect output)
2016-03-12 19:10:39 -08:00
John Scipione
8db20d05cb BColorControl: Standardize on useOffscreen
...instead of doubleBuffered for the flag that specifies whether or not to
draw using an offscreen buffer.

Also remove the (not currently used) text from the docs since the parameter
is being used.
2016-03-12 19:10:38 -08:00
Augustin Cavalier
f2df0cfe93 interface_guidelines: Add a Haiku-esque stylesheet.
Fixes #11782.
2016-03-07 14:29:24 -05:00
looncraz
7f9368cae5 Set*UIColor, etc.
The inseparable changes necessary to support live color updating across the
system in a sane, safe, and performant manner.

BView gains:

HasSystemColors()
HasDefaultColors()
AdoptSystemColors()
AdoptParentColors()
AdoptViewColor(BView*)
SetViewUIColor(color_which, float tint)
SetHighUIColor(...
SetLowUIColor(...
ViewUIColor(float* tint)
HighUIColor(...
LowUIColor(...
DelayedInvalidate()

BWindow gains a simple helper method:
IsOffscreenWindow()

BMessage gains:

AddColor()
FindColor()
GetColor()
HasColor()            * allegedly this API is deprecated, but I implemented it anyway
ReplaceColor()
SetColor()

Previous private ColorTools methods are made public and moved into GraphicsDefs:

mix_color, blend_color, disable_color

These are fully compatible with BeOS dan0 R5.1 methods and are just code cleanup
of BeOS example code under the OpenTracker license.

In addition, four new colors are created:
B_LINK_TEXT_COLOR
B_LINK_HOVER_COLOR
B_LINK_ACTIVE_COLOR
B_LINK_VISITED_COLOR

These changes are documented in their proper user documentation files.

In addition, due to a history rewrite, B_FOLLOW_LEFT_TOP has been defined and
used in lieu of B_FOLLOW_TOP | B_FOLLOW_LEFT and is included in this commit.

On the app_server side, the following has changed:

Add DelayedMessage - a system by which messages can be sent at a scheduled time,
and can also be merged according to set rules.  A single thread is used to service the
message queue and multiple recipients can be set for each message.
Desktop gains the ability to add message ports to a DelayedMessage so that
said messages can target either all applications or all windows, as needed.

Desktop maintains a BMessage which is used to queue up all pending color changes
and the delayed messaging system is used to enact these changes after a short
period of time has passed.  This prevents abuse and allows the system to merge
repeated set_ui_color events into one event for client applications, improving
performance drastically.

In addition, B_COLORS_UPDATED is sent to the BApplication, which forwards the message
to each BWindow.  This is done to improve performance over having the app_server
independently informing each window.

Decorator changes are live now, which required some reworking.

Signed-off-by: Augustin Cavalier <waddlesplash@gmail.com>
2016-01-04 06:48:22 -05:00
Adrien Destugues
ed3c7f8fc2 BTranslatorRoster::Default docs: Further rework and typo fixes 2015-10-26 18:43:35 +01:00
Markus Himmel
7676393722 Minor correction in BTranslatorRoster documentation 2015-10-26 18:40:31 +01:00
Axel Dörfler
2e17b6504f BLaunchRoster::ResetStickyEvent() added.
* Used to unflag sticky events that already have been triggered once.
2015-10-25 14:41:17 +01:00
Axel Dörfler
7cd19b7e5c launch_daemon: Implemented sticky events, and registration.
* Sticky events are events that keep their signal raised, ie. even if
  a job is initialized afterwards, it will still be triggered.
* Consolidated naming for external events.
* Events are now registered once they are actually being used. This
  allows them to allocate the resources they need to do their thing.
2015-10-17 14:16:26 +02:00
Augustin Cavalier
1ea54e567e docs/user: BAlert: Fix incorrect ::TextView() docs.
TextView() returns *the* BTextView the BAlert is using, not a new
TextView with the contents of the BAlert (which is what this seemed to
imply).
2015-08-26 14:42:11 -04:00
Michael Lotz
5ca445dfc6 FS module docs: Add documentation for entry_cache_add_missing().
This was missed when introducing the feature in hrev49558. Thanks Jérôme
for the pointer!

Also add a note explaining that update operations on cached entries and
the removal of uncached entries are safe.
2015-08-21 21:08:15 +02:00
Michael Lotz
86b5886640 BReferenceable docs: Fix a typo and one obvious mixup. 2015-08-02 23:19:07 +02:00
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
Adrien Destugues
6aa4d138bf LayoutBuilder: document C++ method chaining behavior
Fixes #8515.
2015-01-07 17:29:35 +01:00
Augustin Cavalier
c09cca4a79 BSize docs: fix description of B_SIZE_UNSET.
Thanks Ingo for noticing!
2015-01-07 15:34:49 +01:00
Augustin Cavalier
ab00c90d87 Create docs for BSize class.
Fixes #11713.

Signed-off-by: Adrien Destugues <pulkomandy@gmail.com>
2015-01-07 08:29:33 +01:00
Adrien Destugues
29b7900ec8 Add BJoystick docs to the Haiku Book. 2015-01-06 15:58:50 +01:00
mandar
70916faa5d Add documentation for BJoystick::CountDevices
Signed-off-by: Adrien Destugues <pulkomandy@gmail.com>
2015-01-06 15:58:45 +01:00
luroh
1d5b36cee2 Clean up FreeType outsourcing leftovers
- Remove obsolete FreeType docs
  - Remove obsolete FreeType license
  - Update FreeType license and copyrights in AboutSystem

Signed-off-by: Adrien Destugues <pulkomandy@gmail.com>

Fixes #11697
2015-01-05 11:23:02 +01:00
Markus Himmel
70dc2e27e9 Add BTranslatorRoster documentation 2015-01-03 01:20:35 +01:00
Markus Himmel
b9e01b33ed Fixup BTranslator documentation 2015-01-03 01:20:28 +01:00
François Revol
02bdb5db9a Add libtranslation group definition to doxygen stuff 2015-01-03 01:05:27 +01:00
John Scipione
4536c6033b Update BToolTip class docs, added credit.
with remarks from Axel and PulkoMandy, thanks guys.
2015-01-02 18:15:25 -05:00
Markus Himmel
29608b033c Fix BTranslator documentation formatting
Signed-off-by: Adrien Destugues <pulkomandy@gmail.com>

GCI2014 task https://www.google-melange.com/gci/task/view/google/gci2014/5830218824548352
2014-12-30 22:28:19 +01:00
François Revol
d7c90b6275 Add doxygen file for BTranslator class.
By Markus Himmel (GCI2014).
2014-12-30 04:54:19 +01:00
John Scipione
d87c6913ec Add preliminary BToolTip docs 2014-12-23 17:32:05 -05:00
Adrien Destugues
207212972e BMessage: remove unimplemented GetPointer from headers and docs
* This was never implemented and no one noticed until now.
* A default value for a pointer doesn't make that much sense anyway, so
using the FindPointer method is fine.
2014-12-22 15:01:56 +01:00
John Scipione
d3c4833514 Some more small documentation fixes 2014-12-19 19:58:14 -05:00
John Scipione
5ebeb710ab B_WIDTH_FROM_LABEL was not available until BeOS R5 2014-12-19 19:51:46 -05:00
John Scipione
ce3da8de9f Add docs for BTab and BTabView 2014-12-19 19:51:44 -05:00
John Scipione
a28ddb79ec A few minor fixes to BTextControl docs 2014-12-19 19:51:39 -05:00
John Scipione
d78a330deb Add BTextControl docs 2014-12-18 20:46:30 -05:00
John Scipione
95faf2ce54 Minor doc changes 2014-12-18 20:45:25 -05:00
John Scipione
a03f66b7fb Fix a few errors in the nascent BOptionPopUp docs 2014-12-15 21:14:47 -05:00
John Scipione
71f6259a0f Fix locale docs as suggested by Adrien, more work still needed 2014-12-15 21:12:54 -05:00
Adrien Destugues
244f97dc27 LayoutItem: better documentation for SetExplicitMinSize.
This is a bit counter-intuitive, at least to me, as forcing the minimal
size can lead to the item being smaller than it would otherwise.
2014-12-15 10:46:11 +01:00
Niels Sascha Reedijk
f36b3f9b3e Generate the Makefile for making docsets.
Docset is an increasingly popular format that is used to generate
an index for HTML documentation that can be viewed by specialized
viewers such as Dash (on the Mac). The output can only be generated
on a Mac currently. Enabling the DOCSET parameter will generate a
Makefile in the html output directory, which can be used to generate
the Docset itself.

Enabling the Docset Makefile does not negatively impact other things,
as such it seems safe to just enable it for whoever wants to build
the docset on a mac.
2014-12-08 22:14:24 +01:00
Adrien Destugues
9f9d972f79 Minimal documentation for BOptionPopUp.
This was available in R5 but somehow went missing from our version of
the Be Book (it is documented in the release notes in Tycom Systems
version). Document the more important methods of it, at least.
2014-12-08 14:38:09 +01: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
6db90d17a1 Fix BMimeType::SetIconForType() docs 2014-12-04 19:55:40 -05:00
John Scipione
7ec9bf2f5a A few more small fixes, trying to go quick 2014-12-04 19:33:35 -05:00
John Scipione
9bd3dedfce Fix a bit of copy pasta in the locale docs 2014-12-04 19:23:47 -05:00
John Scipione
4a31c32620 Update locale docs to match new reality.
Created docs for NumberFormat, DateFormat, DateTimeFormat, and TimeFormat
and moved the docs from BLocale to the respective new file. Also
DurationFormat was updated as well.

doxygen once again compiles the docs without warnings.
2014-12-04 19:13:46 -05:00