Commit Graph

473 Commits

Author SHA1 Message Date
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
96efe3b3c0 docs/user: Migrate Axel's "Introduction to the Launch Daemon" from Trac. 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
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
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
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
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
Augustin Cavalier
b95e90657e docs/user: Update search URL following docs migration. 2017-04-15 16:28:06 -04: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
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
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
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
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