Also, lots of little cleanups: formatting, adding return statements and
return values where they were missing, fix spelling mistakes, add newlines to
separate command blocks, remove trailing whitespace.
* Add a note to stop_watching() about the asynchronous nature of node
monitoring and its consequences.
* Also update the breif description and parameters of stop_watching().
* Detail the return values of stop_watching() a bit better.
* Add a note (an \attention actually) to B_STOP_WATCHING flag.
* Fix a spelling mistake and other minor fixes.
With this commit every class in the storage kit is now documented
in the Haiku book!
Thanks to Ingo, Axel, Vincent Dominguez, Tyler Dauwalder, and
everyone who helped document these classes.
* Remove docs from Resources.cpp (leaving the brief description).
* Reformat Resources.h to style it like so many other header files.
* There is one not-entirely style based change. I renamed the outSize
parameter or the LoadResource method to _size as is our convention for out
parameters.
And clean it up a bit. Kept brief description in source.
* Also added Axel to authors in Path.dox and Path.cpp because his name
appears in git blame as working on the docs and code for the file.
I hope he doesn't mind.
* Delete the docs from NodeInfo.cpp and NodeInfo.h
* I snuck a couple of style fixes into NodeInfo.cpp
* I had to make a small modification to MimeType.dox to prevent it
from overriding the docs of one of the methods in NodeInfo.dox.
The interface diagram for BArchivable has become too wide to fit on
the page so I've put the diagram in a box and made it scrollable.
While I'm at it give the interface diagram a silver border and
center it on the page.
* 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.
* Since <em> is used for parameters we can't use it for emphasis.
* Add \a in a few places it was missing to indicate a parameter.
* Change \a to a \c in one instance, param -> constant.
* Lots of whitespace fixes, most just deleting leading tabs.
* Don't indent code blocks, they should be flush to left since any
indentation is preserved in the output.
* Update headers to match User Guide better for font and spacing.
* 14.4px is the default font size (matching user guide).
* because we use em's for page width this makes the text area a bit narrower.
* Make note, warning, stop, remark notifications font size smaller to make
them stand out a bit less and better matches the User Guide.
* Remove the reference to BString::fPrivateData, as it currently really
is marked as private and as such disappeared from the docs.
* Add the various character methods that have been added in the
previous revisions.
* rename B_TRANSLATE_CONTEXT to B_TRANSLATION_CONTEXT and
B_TRANSLATE_WITH_CONTEXT to B_TRANSLATE_CONTEXT, squashing a TODO
* adjust all uses of both macros in Haiku's source tree
* use correct header guard for collecting/Catalog.h
The renamed macros require adjustments to all external applications
using catalogs.
This documentation was provided by Omri Barak, a student participating
in Google Code Initiative (GCI) 2011.
Signed off by John Scipione
Since this is the first class documented in the Game Kit I also added
a reference to the Game Kit to the API docs front page.
* This document was written during GCI 2011
by Peter Poláčik and is explaining how to use
makefile and Jamfile engines to start and
setup new development projects for Haiku.
Signed-off-by: Siarzhuk Zharski <zharik@gmx.li>
CFE is used in the upcoming Amiga X-1000 dualcore PPC board.
* Largely inspired by the OF and U-Boot code.
* Still largely stubbed out.
* The loader builds but I don't have a machine to test it. Anyone interested?
Greater(s2, s1), and adding a negation in front of them is not enough either.
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@43233 a95241bf-73f2-0310-859d-f6bbb57e9c96
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
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
* Remove BNode documentation from the source code and add it to Node.dox
* Rewrite some of the existing documents
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@42986 a95241bf-73f2-0310-859d-f6bbb57e9c96
one one should use.
* Add documentation for BDurationFormat.
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@42976 a95241bf-73f2-0310-859d-f6bbb57e9c96
* Some new classes documented
* Screenshots for the interface kit controls
* A lot of typo fixes
* Some css tweaks
This has some backporting to the current version of Doxygen, since
there are experiments to get coloring similar to the one in the Be
Book that will hopefully be upstreamed in Doxygen.
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@42608 a95241bf-73f2-0310-859d-f6bbb57e9c96
* Added Maciej Baluta's GCI work on NetworkStatus, PowerStatus and
ProcessController with only minor changes.
* Created a page for Daniel Marth's GCI work, based on the wiki page at
https://dev.haiku-os.org/wiki/SystemBinCommands
* Updated translations mostly for Japanese and Italian from the currently
running GCI tasks.
Thanks everyone!
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@39724 a95241bf-73f2-0310-859d-f6bbb57e9c96
Again, review welcome on this in order to decide if we carry on asking students to write api reference pages.
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@39696 a95241bf-73f2-0310-859d-f6bbb57e9c96
I did rework the text a little.
I would like to get some careful review for this. Nielx put out the (valid) concern that he's not confident in random students with no previous Haiku experience to write the API reference.
I'd like to know if I should put online more of these tasks, or if I should stop now because the quality is too low.
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@39686 a95241bf-73f2-0310-859d-f6bbb57e9c96
mailing list if I am then asked to do the work myself ;-)
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@38016 a95241bf-73f2-0310-859d-f6bbb57e9c96
* Also parse the actual code to get the methods shown in the classes, inheritance diagrams, and all that stuff
* Add some docs on date formatting to BLocale
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@37925 a95241bf-73f2-0310-859d-f6bbb57e9c96
* Complete and correct some parts of locale and catalog classes reference
* Ensure the methods are prefixed with the class name so doxygen knows where they belong.
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@37898 a95241bf-73f2-0310-859d-f6bbb57e9c96
* Add a very small part of documentation about the Locale Kit.
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@37873 a95241bf-73f2-0310-859d-f6bbb57e9c96
the file already exists, unless O_EXCL has been specified. At least that's
how our file systems with write support implement it.
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@37554 a95241bf-73f2-0310-859d-f6bbb57e9c96
Entering the boot loader menu has changed/simplified while reducing the boot time by .75 seconds.
Now it is enough to hold one of shift/Esc/F8/F12/Space. Thanks!
I've also updated the boot loader documentation to reflect the change, but I only mentioned holding shift.
I know that changing the documention directly is not preferred anymore, but I wanted to make sure this
patch is complete.
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@35050 a95241bf-73f2-0310-859d-f6bbb57e9c96
* Added shortcuts ctrl-alt-F to get a window to front, and ctrl-alt-b to move it
to the back.
* Updated the user guide with these shortcuts, and also explained the missing
"single click to bring window to front" behaviour.
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@34108 a95241bf-73f2-0310-859d-f6bbb57e9c96
to avoid recurring problems during migration of subversion checkouts
(restored binary files that were garbled by subversions during checkout)
* added appropriate svn:mime-type property for problematic (binary) files
* removed a single (mistyped) svn:mimetype property
* dropped svn:eol-style property for cleanup (they all contained 'native')
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@33670 a95241bf-73f2-0310-859d-f6bbb57e9c96
* Clarified the intent of OptionalPackages a bit on the Welcome page. (Unless it
should be removed completely. This is for an alpha-release, though...)
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@33164 a95241bf-73f2-0310-859d-f6bbb57e9c96
and save panels" subchapter in gui.html
* Corrected link to DriveSetup in installer.html
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@33117 a95241bf-73f2-0310-859d-f6bbb57e9c96
(for the enduser) interesting info, please add to it.
* Linked to the Replicant section where appropriate.
* Added gui-images folder for language-independent images.
+alphabranch
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@32968 a95241bf-73f2-0310-859d-f6bbb57e9c96
* Updated safe mode options in bootloader.html.
* Renamed menu in Tracker windows "Attributes|Copy/Paste Attributes" to
"Attributes|Copy/Paste Layout".
+alphabranch
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@32909 a95241bf-73f2-0310-859d-f6bbb57e9c96
* Vincent also saw that the logo bg-color is #eeeeee instead of #efefef.
->Corrected CSS.
Also, there can be issues with PNG inside div-blocks setting a bg-color. PNGs
include a color profile that can screw browser rendering to display different
colors though using the same RGB values. Interesting. See
http://www.kaktus.cc/weblog/png_and_color_profiles/
I stripped the color profile info from the logo.png as suggested at that URL.
Thanks Vincent!
+alphabranch
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@32804 a95241bf-73f2-0310-859d-f6bbb57e9c96
* Changed "up-to-top-of-page" symbol to a 90° rotated bullet graphic of the new
website (Good idea, Jorge.). Increased its size to 32x32 so it's easier to
aim for.
* Mentioned new ~/config/boot/launch/ folder in filesystem-layout.html.
* Updated Workspaces screenshot due to renamed options (Thanks Ryan.)
* Moved magnify.png to the /en/images/apps-images/ subfolder as it's not totally
language neutral.
+alphabranch
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@32759 a95241bf-73f2-0310-859d-f6bbb57e9c96
* Changed "up-to-top-of-page" symbol to a 90° rotated bullet graphic of the new
website (Good idea, Jorge.). Increased its size to 32x32 so it's easier to
aim for.
* Mentioned new ~/config/boot/launch/ folder in filesystem-layout.html.
* Updated Workspaces screenshot due to renamed options (Thanks Ryan.)
* Moved magnify.png to the /en/images/apps-images/ subfolder as it's not totally
language neutral.
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@32754 a95241bf-73f2-0310-859d-f6bbb57e9c96
* Changes on all pages and CSS for
- min/max width
- topic title to the left under the logo
- a new logo (thanks Jorge)
- refurbished navi bar
- some more printing tweaks
There are a few CSS issues where I can use some help. I'll post about it on the
documentation mailing list.
+alphabranch
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@32651 a95241bf-73f2-0310-859d-f6bbb57e9c96
mailing list to welcome.hmtl
* Linked to HaikuPorts for BeZilla bug reports.
* Put Axel's tip how to move/send to back (didn't know that!) into a box-info.
Minor changes to the text.
* Put Axel's "special functionality" of Workspaces into a nice table.
* Added new function to cycle thru windows with CTRL ~ to Twitcher.
* Added CTRL+SHIFT+CursorLeft/CursorRight to switch tabs to Terminals keyboard-
shortcuts
* New e-mail-mailbox.png with vector icon in Deskbar.
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@32628 a95241bf-73f2-0310-859d-f6bbb57e9c96
noticed.
* Humdinger, the GUI image does not have item 5) for the resize knob!
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@32579 a95241bf-73f2-0310-859d-f6bbb57e9c96
- Move the launching of files in this directory from the Bootscript to the
UserBootscript.
- This means we now ship a working UserBootscript instead of just a sample.
- Updated documentation based on this change and Humdinger's suggestions.
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@32544 a95241bf-73f2-0310-859d-f6bbb57e9c96
there is a better place please move it there. Also fixed a bad link in the
Tracker section.
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@32528 a95241bf-73f2-0310-859d-f6bbb57e9c96
