- add mention of libc6-dev-i386 which I had to install on a 64bit server,
- fix a typo.
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@30777 a95241bf-73f2-0310-859d-f6bbb57e9c96
* Adjusted links in the nav-bar of all the apps' docs to jump to the
#list-of-apps instead of to the top of applications.html
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@30397 a95241bf-73f2-0310-859d-f6bbb57e9c96
- inline acronym definitions and remove the dotted underline
- inline urls for a tags with printurl class (we don't want all of them printed)
- noprint class for things we might not want to print at all
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@30347 a95241bf-73f2-0310-859d-f6bbb57e9c96
in tracker.html
* Documented PoorMan.
* Added yasm to the required packages when building Haiku under Linux
* changed every /boot/beos/ to /boot/system/
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@30247 a95241bf-73f2-0310-859d-f6bbb57e9c96
* Fixed and completed several function documentations. There's still quite
a bit missing.
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@29787 a95241bf-73f2-0310-859d-f6bbb57e9c96
with the current API, but it just needs to be updated rather than rewritten
from the scratch.
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@29766 a95241bf-73f2-0310-859d-f6bbb57e9c96
* Renamed "Showimage" to "ShowImage". Thanks mmadia.
* Some more tweaking of box padding in the CSS.
* Added "Expander", adjusted contents of applications.html
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@29648 a95241bf-73f2-0310-859d-f6bbb57e9c96
improvements. I added mentioning the UserBuildConfig a couple more times
further down, just in case someone skipped these parts. Then the mentioned
commands won't work.
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@29606 a95241bf-73f2-0310-859d-f6bbb57e9c96
* Changed cursor keys to their respective arrow symbol
* As mmadia reminded me: since we cannot use Mozilla's Trademarks I renamed
everythig firefoxy to BeZillaBrowser.
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@29398 a95241bf-73f2-0310-859d-f6bbb57e9c96
* Always wanting keyboard graphics for shortcuts, Jorge suggested simple borders
for simplicity. Great idea! Added.
* Added Jorge's rounded boxes for note/warning/stop plus symbols.
* If anyone wants to fine tune esp. colours, go ahead. Jorge and I are both
challenged in that department. :)
* A few small corrections and reformatting here and there.
* Excluded the topic "Installation" from the contents until it's further along.
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@29269 a95241bf-73f2-0310-859d-f6bbb57e9c96
which in turn mentions the new Tracker preferences. Thanks aldeck for
reminding me.
* Added Tracker icons.
* Added Tracker on the Preferences contents page.
* Small tweaks and corrections here and there.
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@29183 a95241bf-73f2-0310-859d-f6bbb57e9c96
WIP:
* Only a first subset of CSS has been applied
* Look based on Humdinger's and other's work on user guide
* Navigation is still ugly. I need to work around the limitations of Doxygen. Maybe by a patch though.
* Needs a manual extra step: you need to copy the /trunk/docs/userguide/images/logo.png to the /trunk/generated/doxygen/html directory
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@29117 a95241bf-73f2-0310-859d-f6bbb57e9c96
* Added CodyCam to list of apps in applications.html
* Added aligning tip for icons to tracker.html
* Added a few tips for working in Terminal
* Added a topic on scripting, linking to online resources
* Described function of UserBootscript an shutdown scripts
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@29105 a95241bf-73f2-0310-859d-f6bbb57e9c96
It's based on the blog articles of several people that will be credited in each
page's header comment soon.
* Did a little additional formatting and restructuring.
* This is still a work in progress as we continue to restructure and remove redundancies.
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@28925 a95241bf-73f2-0310-859d-f6bbb57e9c96
BTW, sometimes it is (undocumented application pages), sometimes it's not.
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@28895 a95241bf-73f2-0310-859d-f6bbb57e9c96
CDPlayer and CodyCam (both work in progress), DeskCalc
* Started installing.html.
* Added a screenshot of Glyph+Subpixel rendering to Appearance prefs.
* Mentioned new setting "Monospaced Fonts Only" glyph hinting in Apperance prefs
* Mentioned sysinfo and listdev in bugreports.html as pointed out by scottmc.
* Some tweaks to the Haiku-doc.css.
* Put a link to http://www.haiku-os.org/community into welcome.html,
removed the "(online)".
* Reorganized the file hierarchy to accommodate future translations. See thread:
http://www.freelists.org/post/haiku-doc/Organizing-translations-of-User-GuideWelcome-Package.
* Added a userguide/languages.html that will serve as entry for the different
translations.
Since the welcome page is more or less only one page, we'll find another
solution for that when the first translations are available.
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@28890 a95241bf-73f2-0310-859d-f6bbb57e9c96
* Added explanation of icons to Bootloader.
* Applied css-fix by Braden Ewing to fix rendering under MS Internet Explorer.
Added Braden to welcome.css authors.
* Added a css class pre.terminal to make Terminal output more visible plus a few more
things. Added myself to welcome.css authors. :)
* Updated all Terminal output with the new pre-class tag.
* Flaunted our beautiful icons at the top of every preference/application/applet plus
their contents page.
* Added icon PNGs in 16x16 32x32 and 64x64.
* Added quick info where to find a preference/application/applet and its settings at the
top of every page.
* Added apps: ActivityMonitor, Magnify, StyledEdit, Terminal
* Added applet: Launchbox
* Added stubs to all missing prefs/apps/applets. Everyone's welcome to work on the
contents (announce it on the mailing list, though!).
* Moved preference/application/applet into own folders.
* Updated contents page.
* Reformatted everything to be XHTML1.0-Strict conforming. Added XHTML DTDs to
welcome/html-dtd/.
* Added copyright and author as comment to the header of every page. If someone else
should be mentioned there, speak up.
---
Whoot! What a titanian piece of work, Humdinger!
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@28791 a95241bf-73f2-0310-859d-f6bbb57e9c96
* Added docs and screenshots for preference panels:
Appearance, Backgrounds, DataTranslations, E-mail,
Filetypes, Fonts, Keyboard, Keymap, Menu, Mouse,
Network, Screen, Screensaver, Sounds, Time, VirtualMemory
Adapted some contents for E-mail preferences from
src/documentation/haiku_user_guide/HaikuUserGuide.txt
As I haven't succeeded to get email running in vmware, I'd appreciate if someone
can proof read what's written in E-mail preferences.
* Added preferences to the user guide contents.
* Various formatting details and inter-documents-links
Wow! Thanks a lot!
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@28555 a95241bf-73f2-0310-859d-f6bbb57e9c96
* Slightly improved the wording on the Welcome page
* Corrected some wrong HTML tags here and there
* Improvements on the Bug Reports page
* Added paragraph on file panels on the general GUI page
* Added Filesytem Layout page
* Added Boot Loader page (kernel boot options)
* Added Keyboard Shortcuts page (also moved the paragraph about default command
key there)
* Prepared index pages for Applications, Preferences, Demos and Desktop Applets
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@28389 a95241bf-73f2-0310-859d-f6bbb57e9c96
* Various fixes and corrections
* Preparation for new sections
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@28332 a95241bf-73f2-0310-859d-f6bbb57e9c96
* Refactored a User Guide style documentation from the previous Welcome
documentation. The Welcome documentation links to the User Guide, the
biggest difference is that there is now a separate contents page.
* Improvements to the text.
* Added Tracker-Add-ons page.
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@28211 a95241bf-73f2-0310-859d-f6bbb57e9c96
* Added the missing Team Monitor intro.
* Fixed navigation in the preceeding and following files.
Changes by myself:
* Removed the bottom navigation in the Twitcher intro, since the file is so
short anyways.
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@28027 a95241bf-73f2-0310-859d-f6bbb57e9c96
* Improved Tracker and Deskbar introductions.
* Updated and improved a few graphics and added some more.
(Humdinger: The Teammonitor intro was missing from your patch.)
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@27995 a95241bf-73f2-0310-859d-f6bbb57e9c96
the logo area is very simple now, as well as the navigation area. Tweaked
the looks to remind a little of the Haiku website look.
* Incorporated patch by Humdinger (better "Open With..." menu screen shot,
added "Open With Preferred" screen shot and text.)
* Some minor fixes here and there.
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@27929 a95241bf-73f2-0310-859d-f6bbb57e9c96
* Changed the design of the logo area and worked on the document margins
and overall layout.
* Added a navigation infrastructure.
* Worked on the text on the Welcome page - Added an actual welcome paragraph
and unified the bug sections. Slightly changed the paragraph ordering.
* Fixed some typos, added small bits of text to the Tracker topic.
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@27907 a95241bf-73f2-0310-859d-f6bbb57e9c96
Firt version of the "Welcome Package" introductory documentation.
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@27846 a95241bf-73f2-0310-859d-f6bbb57e9c96
was originally written by Mike Steed. The code was freely available from his
website at one point, which I am no longer able to find. I believe the license
was a kind of public domain, at least compatible with our MIT/X11 license.
The original code was well written with it's own coding style which was not
very far from the Haiku coding style. I have hopefully adopted it completely
to our coding style. While I did this, I came across several places with
comments for a minor bug which I was able to resolve all. I also found ways
to simplify certain places and I elliminated all non-necessary "inter-class
knowledge" which was used to directly access members of other classes which
should have been private.
All in all, this should be a nice little addition, a useful tool which I found
handy a lot of times. If I should not have added this without first consulting
everyone, please voice your disagreement, and it can be removed it again. It
is not part of the image yet.
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@27357 a95241bf-73f2-0310-859d-f6bbb57e9c96
and publish it on the website - comments are still welcome, though.
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@25802 a95241bf-73f2-0310-859d-f6bbb57e9c96
more over the following days, and published on the website.
Comments welcome!
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@25760 a95241bf-73f2-0310-859d-f6bbb57e9c96
responsibility never to call notify_select_event() after deselect().
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@25262 a95241bf-73f2-0310-859d-f6bbb57e9c96
Note: I have cleared the original MessageQueue.cpp file from the inline documentation. When the storage kit comes up, we need to rediscuss the documentation policy.
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@24522 a95241bf-73f2-0310-859d-f6bbb57e9c96
readlink() function. It is no longer required to null-terminate the
string, shall not fail, if the buffer is too small, and shall return
the length of the string actually written into the buffer.
* Adjusted rootfs, devfs, and bfs accordingly. Also adjusted their
read_stat() hooks to return the correct symlink length in st_size.
* Our readlink() does now comply to the standard (and BeOS).
Additionally if the buffer is big enough it is nice to non-conforming
apps and null-terminates it.
* BSymLink::ReadLink() explicitly null-terminates the string now.
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@24425 a95241bf-73f2-0310-859d-f6bbb57e9c96
- Small link fix
- Clean up the titles of the subsections a bit: these are reused in the looper documentation and they sort of clashed before.
Also, new documentation for Looper.dox!
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@24304 a95241bf-73f2-0310-859d-f6bbb57e9c96
passed phase 3, so they wouldn't be updated during the regular process.
I guess the other files will get that update.
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@21833 a95241bf-73f2-0310-859d-f6bbb57e9c96
guidelines. Three new guidelines:
- Commas between names and email adresses in header blocks.
- Indent with tabs (with lenght 4)
- Two whitelines between blocks
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@21832 a95241bf-73f2-0310-859d-f6bbb57e9c96
Kamikazow which can be seen as an attachment to bug #1356.
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@21831 a95241bf-73f2-0310-859d-f6bbb57e9c96
* Replaced some more spaces with tabs, though still not complete.
* And I forgot: the last commit also removed some garbage at the beginning of the file.
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@21617 a95241bf-73f2-0310-859d-f6bbb57e9c96
* The documented the notify_*() functions - only notify_listener() was deprecated
among them.
* Replaced spaces with tabs - there is no reason to deviate from the standard we're
using everywhere else.
* Completed the docs here and there.
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@21615 a95241bf-73f2-0310-859d-f6bbb57e9c96
Please update your executable if you are generating the documentation.
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@21404 a95241bf-73f2-0310-859d-f6bbb57e9c96
"Phase III .diff for BlockCache.dox.
Not much to change here, some really minor things only. The thing
that makes the .diff large is the fact that many lines were more like
70char than 80char."
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@21258 a95241bf-73f2-0310-859d-f6bbb57e9c96
"Fixed the indentation and went over the cross references. Everything appears
to be in order and should be ready for committal. It adheres to the coding
guidelines and should be good to go."
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@21206 a95241bf-73f2-0310-859d-f6bbb57e9c96
"I have made the doc header consistent with what the document content
specifies it should be.
I've rephrased things and corrected typos and spelling.
Checked through the grammar and amended some gramatical errors."
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@21103 a95241bf-73f2-0310-859d-f6bbb57e9c96
- Add the beginnings of the documentation for the USB module
- Fix some mistakes here and there
- Almost finished the support kit. Tried to update everything to the standards
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@20724 a95241bf-73f2-0310-859d-f6bbb57e9c96
read-only FS are documented, now. Be encouraged to review and add more. :-)
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@20568 a95241bf-73f2-0310-859d-f6bbb57e9c96
* BufferIO.dox Reformat according to the guidelines
* DataIO.dox Reformat according to the guidelines
* Flattenable.dox New documentation.
* Locker.dox Finished documentation.
* SupportDefs.dox Reformat according to the guidelines
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@20511 a95241bf-73f2-0310-859d-f6bbb57e9c96
* book.dox Rework a bit of the structure
* midi2/support Separate the overview (or Introduction) from the list of elements in a module.
* support Wrote initial documentation for Beep/BufferIO/DataIO
* Stub for article on archiving.
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@20307 a95241bf-73f2-0310-859d-f6bbb57e9c96
* Finish up documentation for BString
* Trying to work a bit more on the structure.
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@20236 a95241bf-73f2-0310-859d-f6bbb57e9c96
I will keep working on the Docbook version, but as I'm still not completely comfortable with that as final choice, I'm playing around with this as well.
The String.cpp file contained doxygen documentation for almost all methods, I copied those to a new file (string.dox) and grouped them accordingly. (Done because Axel is absolutely against in-header or in-source docs)
Integrated the BMidiConsumer and BMidiLocalConsumer class into the same file (like I did now to the producers), since I think it's better to keep a 1:1 relation with the headers.
Removed the mididefs.dox file and replaced it with the midi2/Midi2Defs.dox file which actually documents the Midi2Defs.h file, rather than contain a custom page that was somewhat hard to find.
Please see http://www.myhouserules.nl/haiku_book/index.html for a generated book from the current source. I actually quite like the output so far, though I'm aware of the fact that I needed to perform some tricks to let Doxygen get to this point.
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@19651 a95241bf-73f2-0310-859d-f6bbb57e9c96
Started 'copying' some comments from the String.cpp file.
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@19642 a95241bf-73f2-0310-859d-f6bbb57e9c96
in several steps:
1. early pre-registration with the registrar ("I wanna launch the
app, make sure noone interferes.")
2. load the app image
3. finish pre-registration with the registrar ("I have launched
the app, here is its team ID.")
4. start app main thread
5. send "on launch" messages to the app (argv, refs, others)
If the app is already running or being launched, 1. fails with a
conclusive error code and returns the team ID and the pre-registration
token of the app. Steps 2 - 4 are skipped and only the messages are
delivered using the team ID returned by 1.
This change fixes a race condition: The failed early pre-registration
request obviously cannot return the team ID, if the other thread
launching the app has not finished step 3 yet. Thus the argv/refs
message would not get delivered and Launch() would not return the
correct team ID.
Now we wait for the pre-registration to be finished in this case, using
the former _IsAppPreRegistered() mechanism, which already provided
such a waiting feature for one request. It has been extended to
accomodate an arbitrary number of waiting requests and renamed to
_IsAppRegistered().
This fixed bug #763.
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@18728 a95241bf-73f2-0310-859d-f6bbb57e9c96
* Moved the documentation that might still be helpful into an "obsolete" directory.
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@18237 a95241bf-73f2-0310-859d-f6bbb57e9c96
different "force" levels now and updates the app file info attributes
for shared object files.
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@16123 a95241bf-73f2-0310-859d-f6bbb57e9c96
