Niels Sascha Reedijk
a6b0b081cc
Update userguide translations
2013-02-17 21:56:39 +01:00
François Revol
cb77e62c17
Merge branch 'master' into sam460ex
2013-02-16 22:58:27 +01:00
John Scipione
0a9ac70aea
Move BQuery docs into Haiku Book.
...
... removing the docs from the .cpp and .h files and cleaning up as usual.
2013-02-14 19:36:33 -05:00
John Scipione
6d287908b1
Fix warning and cleanup for BPath docs
2013-02-14 19:35:48 -05:00
François Revol
8d96ebeb59
Merge branch 'master' into sam460ex
2013-02-12 19:48:05 +01:00
John Scipione
855a423a5e
Forgot this, add a period
2013-02-10 16:13:03 -05:00
John Scipione
61feea6280
Minor BPath doc cleanups.
...
* Implements BFlattenable::method not overrides, pure virtual.
* Tense of return values should be past.
2013-02-10 16:10:25 -05:00
François Revol
88fe1cd3a5
Merge branch 'master' into sam460ex
2013-02-09 16:25:21 +01:00
John Scipione
4c064a8451
Move documentation from Path.cpp to Path.dox
...
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.
2013-02-09 00:39:53 -05:00
John Scipione
b3252dc18a
NodeMonitor doc updates
2013-02-08 22:43:36 -05:00
John Scipione
185c12a1b7
Whoops, NodeInfo.h not Node.h
2013-02-08 22:42:54 -05:00
John Scipione
5367161777
Some updates to NodeInfo docs
2013-02-08 22:14:09 -05:00
John Scipione
fc9827011d
Moved NodeMonitor docs to Haiku Book.
2013-02-08 20:39:35 -05:00
John Scipione
66d07bdfce
Copy-pasta error: storage not app
2013-02-07 23:22:22 -05:00
John Scipione
81c42a7685
Move documentation from NodeInfo into the API docs.
...
* 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.
2013-02-07 23:17:01 -05:00
John Scipione
131261d2b5
Remove remaining /trunk/ before file references.
2013-02-07 21:19:06 -05:00
François Revol
5d9c157d6e
Merge branch 'master' into sam460ex
2013-02-08 01:38:37 +01:00
John Scipione
51fe39ae0f
Renamed stopwatch.dox to StopWatch.dox
2013-02-07 16:04:04 -05:00
John Scipione
faeb2ff331
Move syslog.dox from support to posix and put it in libroot.so
2013-02-07 15:52:25 -05:00
John Scipione
a93a16151d
Fix doxygen warnings, enums can only be in 1 group
2013-02-07 15:52:07 -05:00
John Scipione
41611c9c5e
Assign class docs for app and support to libbe group, not libroot
2013-02-07 15:04:05 -05:00
John Scipione
30b280b217
Style the interface diagram title as an h2
2013-02-07 14:49:43 -05:00
John Scipione
027cfe666e
Bound the interface diagram.
...
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.
2013-02-07 14:42:20 -05:00
John Scipione
db5b891db2
Move app and support class docs from libbe to libroot.
...
Also a few more style and spelling fixes.
2013-02-07 14:19:09 -05:00
John Scipione
6dc7e05ecf
Update BBuffer class docs.
2013-02-07 02:11:09 -05:00
John Scipione
820dca4df6
Big docs cleanup.
...
* 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.
2013-02-07 02:01:19 -05:00
François Revol
34a12c7678
Merge branch 'master' into sam460ex
2013-02-03 00:39:40 +01:00
John Scipione
b7733e0655
Move Mime.h documentation to the API docs.
2013-01-31 20:47:06 -05:00
John Scipione
ec96e7af1a
Fix warning in FilePanel.dox
2013-01-30 19:51:01 -05:00
John Scipione
400a2a1813
Fix warning in DurationFormat.dox
2013-01-30 19:50:41 -05:00
John Scipione
8bbea122eb
Use the version from the cpp file, not the header for \fn
2013-01-30 19:38:55 -05:00
John Scipione
bf20349b34
Correct a few more param instances in BHandler docs
2013-01-30 19:35:50 -05:00
John Scipione
ce5b408f1f
A few doc fixes to BApplication and BHandler.
...
* 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.
2013-01-30 19:18:30 -05:00
John Scipione
a3c5efd2e9
Color parameters in parameter lists grenadier (orange) as well.
2013-01-30 18:58:55 -05:00
John Scipione
c896b0c34c
Color parameters grenadier (orange) in API docs.
2013-01-30 18:54:16 -05:00
John Scipione
8bbff5c9ed
Update dd style in API docs.
...
Only make the font size 12px for the special note, warning, etc. blocks
not all dd blocks.
2013-01-30 18:43:09 -05:00
Alexander von Gluck IV
9a5c1309d7
doc: Add some OpenGL kit documentation
...
* Reduce bus factor.. this stuff is complex.
( I blame the developer who wrote it :\ )
2013-01-27 16:46:09 -06:00
John Scipione
90ae2e54f6
Update keycodes image with more stylish version
2013-01-21 20:10:59 -05:00
François Revol
287040333d
Merge branch 'master' into sam460ex
2013-01-20 23:57:00 +01:00
John Scipione
3528f5bb69
Add BBitmapStream docs and translation kit stub
2013-01-19 15:05:11 -05:00
John Scipione
6a4b222bc9
Use condensed, not squished together. Better
2013-01-19 13:17:50 -05:00
John Scipione
4f7717a999
By removing the style on escapement_delta doxygen links it up which is better
2013-01-19 13:17:49 -05:00
John Scipione
27c3eae9b4
Another minor fix, style constant
2013-01-19 13:17:49 -05:00
John Scipione
0d2b04ca83
Minor update use fixed font for B_OK
2013-01-19 13:17:49 -05:00
John Scipione
05757eb6b3
Fill out BFont detailed description.
...
Also a bunch of cleanup including removing private method docs
and cleaning up language. BFont is pretty much completely documented
at this point.
2013-01-19 13:17:48 -05:00
John Scipione
c258d2fa0e
Fill out BFont member docs
2013-01-19 13:17:47 -05:00
John Scipione
566e828c5f
Add initial BFont documentation
2013-01-19 13:17:46 -05:00
John Scipione
c45e8003d3
Update font size of memberdoc tables from 13px to 14.4px
2013-01-17 18:13:05 -05:00
John Scipione
4aae53f373
Update Haiku Book CSS
...
* 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.
2013-01-16 12:44:22 -05:00
John Scipione
5e6540723d
Update BFilePanel docs, especially detailed description and constructor
2013-01-15 23:07:12 -05:00
François Revol
7daaf25d9c
Merge branch 'master' into sam460ex
2013-01-15 07:09:10 +01:00
John Scipione
2b934bb6ae
Add BFilePanel and BRefFilter documentation
2013-01-14 23:31:18 -05:00
John Scipione
ea468b9855
Add \brief tag so description appears in files table
2013-01-14 21:11:15 -05:00
John Scipione
0abbcaaa35
Update Doxyfile to 1.7.5.1
2013-01-14 20:33:50 -05:00
François Revol
0ccce7886f
Merge branch 'master' into sam460ex
2012-12-27 15:50:06 +01:00
John Scipione
93ebe7637f
Update BDurationFormat docs. Came for warnings, ended up fixing more.
2012-12-24 19:55:26 -05:00
John Scipione
89dfe27fc8
Update BCatalog docs to fix warnings and update.
...
Especially listing the status codes is useful. Some style fixes and
update \li to -.
2012-12-24 19:07:56 -05:00
John Scipione
495275e4ea
Add BFileInterface class documentation
2012-12-24 18:36:55 -05:00
John Scipione
c8654dba73
Minor updates to BFileGameSound docs
2012-12-24 18:31:08 -05:00
John Scipione
939600d2ad
Update SetPaused() and add IsPaused() documentation
2012-12-24 16:05:51 -05:00
John Scipione
05c71c9699
Add BFileGameSound class documentation
2012-12-24 15:42:48 -05:00
François Revol
be95f65a23
Merge branch 'master' into sam460ex
2012-12-24 01:52:39 +01:00
John Scipione
e1988c7d53
Reduce font size of code blocks to 13px
2012-12-23 12:05:03 -05:00
John Scipione
e9191cc2d1
Add BFile documentation to the Haiku Book.
...
Remove the documentation from the cpp file also. Keep the brief
description as a regular comment though.
2012-12-22 15:01:17 -05:00
John Scipione
8e7094494a
Fix another warning in MimeType.dox along with some 80 char fixes
2012-12-22 15:01:17 -05:00
John Scipione
268177055e
Fix 2 warnings in MimeType.dox
2012-12-21 22:51:19 -05:00
John Scipione
f729cb8d48
Remove methods from CheckBox.dox that are not unique to the class fixing warnings
2012-12-21 22:51:19 -05:00
John Scipione
177942adc7
Remove documentation fro Button.dox that is not unique to BButton fixing a few warnings
2012-12-21 22:51:18 -05:00
John Scipione
e5f2a41917
Update revision, this matters because I changed the variables in the BDragger constructor.
2012-12-21 22:34:27 -05:00
John Scipione
a6ada82b00
Add BDragger class documentation
2012-12-21 22:31:29 -05:00
John Scipione
ceaf7141fa
BDirectWindow class documentation fixes
2012-12-21 21:01:40 -05:00
John Scipione
b1b809ef27
Add preliminary DirectWindow documentation
2012-12-21 20:38:18 -05:00
John Scipione
746abcb938
Add BCursor class documentation
2012-12-21 18:26:29 -05:00
François Revol
0e4a0c0e7f
sam460ex: one more address in the notes
2012-12-19 16:08:49 +01:00
François Revol
6ccf5f95c0
sam460ex: add port notes (org-mode format)
2012-12-19 15:34:23 +01:00
Przemysław Buczkowski
46cf7a5a73
Fix typos: super block -> superblock ( #8974 )
...
Signed-off-by: Przemysław Buczkowski <przemub@yahoo.pl>
Signed-off-by: Matt Madia <mattmadia@gmail.com>
2012-12-09 08:47:46 -05:00
Ithamar R. Adema
0f16abe379
Update todo notes
2012-11-22 21:30:54 +01:00
Niels Sascha Reedijk
2df12e67c1
Sync userguide from i18n.haiku-os.org.
2012-11-15 22:36:54 +01:00
Ithamar R. Adema
6645e68bb0
ARM: add todo note about VM implementation
...
Signed-off-by: Ithamar R. Adema <ithamar@upgrade-android.com>
2012-11-13 12:12:23 +01:00
Humdinger
d3f77ddee3
Added correct flags for Hungarian and Brazilian.
...
+alpha4 (just in case its rebuild...)
2012-11-08 20:05:45 +01:00
Rene Gollent
2862f14d68
Added todo list.
...
Lists missing/incomplete Debugger features. Not exhaustive.
2012-11-07 23:18:23 +01:00
Ithamar R. Adema
b0cef9d956
ARM/docs: add a TODO with the major open issues for this port.
...
Personally I find KDL hangman the biggest blocker, but oh well...
2012-11-07 17:20:47 +01:00
Ithamar R. Adema
9f512d6188
document architectural limitations of ARM port
...
Sure there are more, but this is at least a start for now ;)
2012-11-07 17:05:18 +01:00
François Revol
7c0097cb42
Even some more FDT/OF refs...
2012-11-06 20:14:55 +01:00
François Revol
6d8c8c0b32
Even more FDT references
2012-11-06 10:59:58 +01:00
François Revol
f8e10024ad
Some more FDT references
2012-11-06 10:39:23 +01:00
François Revol
bc61f38130
Add some ARM references
...
* Actually stuff about FDT for now, also useful for other arch like PPC.
2012-11-06 10:33:07 +01:00
François Revol
35ef01c566
m68k: Add some atari references to the port docs
2012-11-05 20:58:04 +01:00
François Revol
a6e7fd728d
m68k: Add some references to the port docs
2012-11-05 20:50:12 +01:00
François Revol
c2ee0abbc1
m68k: Remove one thing done from the TODO list
2012-11-05 20:50:12 +01:00
Niels Sascha Reedijk
5bde1d438b
Update userguide from i18n.haiku-os.org.
2012-08-18 10:28:04 +02:00
Niels Sascha Reedijk
4b140bad0d
Update the BString documentation.
...
* 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.
2012-05-12 11:54:07 +02:00
Oliver Tappe
546208a539
More catalog-related cleanup.
...
* 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.
2012-04-16 21:31:22 +02:00
John Scipione
12c10314f9
Remove MimeType docs from MimeType.cpp and cleanup style issues in that file. Create a MimeType.dox file and add the docs there.
2012-03-18 00:09:53 -04:00
Niels Sascha Reedijk
b39e687949
Update welcome pages from i18n.haiku-os.org
2012-02-17 20:39:23 +01:00
Niels Sascha Reedijk
4ac8d3e9e4
Update userguide from i18n.haiku-os.org
2012-01-31 11:50:22 +01:00
Niels Sascha Reedijk
c9d16a1694
Update the userguide from i18n.haiku-os.org
2012-01-02 08:17:34 +01:00
Niels Sascha Reedijk
646c788ab6
Update documentation from i18n.haiku-os.org
2012-01-02 08:16:11 +01:00
John Scipione
f969ed4153
A few formatting tweaks in the BEntry and BDirectory class documentation.
2011-12-18 21:43:22 -05:00
John Scipione
d4fa97f8f8
Moved documentation for the BEntry class into a dox file to include it into the Haiku book.
2011-12-18 21:28:55 -05:00