Commit Graph

66 Commits

Author SHA1 Message Date
Naba7 a8edaa2b21 Add some documentation for BUrl.
Change-Id: I9db68f77d80c246fce5011247471972c3f1bf68a
Reviewed-on: https://review.haiku-os.org/c/haiku/+/1419
Reviewed-by: Niels Sascha Reedijk <niels.reedijk@gmail.com>
2019-12-09 19:00:20 +00:00
Niels Sascha Reedijk 4679af2788 API Docs: add various missing elements to support kit.
* Adds missing methods to BArchivable, BList and BString.
* Add missing defines to SupportDefs.h
2019-09-19 21:57:13 +01:00
Niels Sascha Reedijk 2afda31c8f API Docs: add skeletons for BBufferedDataIO, BStringList and BStackOrHeapArray 2019-09-19 21:57:13 +01:00
Niels Sascha Reedijk eaf8dff073 API Docs: add skeletons for BUrl and BAlignment and complete BAlert 2019-09-19 21:57:12 +01:00
Augustin Cavalier 414b21c497 docs/user: Fix description of bigtime_t. 2018-12-14 18:59:17 -05:00
John Scipione 44b874666a API docs: it's => its fix 2017-11-09 13:23:55 -08:00
Augustin Cavalier 0bb2d0ecad docs/user: Status codes are defined in Errors.h, not Error.h. 2017-06-14 18:05:31 -04:00
John Scipione 1eed6ef172 BString docs: document IStartsWith() and IEndsWith() 2017-02-21 18:03:03 -08:00
Michael Lotz 86b5886640 BReferenceable docs: Fix a typo and one obvious mixup. 2015-08-02 23:19:07 +02:00
Augustin Cavalier 64f7e980a4 BString docs: don't have tags in hsection titles. 2015-04-06 17:51:04 -04: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
Stefano Ceccherini c804ffd3b7 Documentation: Fix typo in BString 2014-09-09 23:05:18 +02:00
Ingo Weinhold 8546c4160e BPositionIO: Add {Read,Write}AtExactly()
Analoguous to {Read,Write}Exactly(), just for the *At() versions.
2014-07-12 15:40:21 +02:00
Ingo Weinhold b773d89eba BDataIO: Add Flush() 2014-06-30 21:55:40 +02:00
John Scipione 5b55bbb0a6 BString docs: Add docs for StartsWith() and EndsWith()
I'm not sure why these method docs got skipped, they are
nice to know about.
2014-06-30 14:50:20 -04:00
John Scipione 798a273725 BString docs: Fix a bunch of other stuff.
A lot of clarification.

Also, sometimes "the object" was used to refer to the BString you're doing
stuff to and sometimes "the BString" was used, settle on "the BString".
2014-06-25 15:39:08 -04:00
John Scipione 79c6af799c BString docs: Remove extra "to" in AppendChars() string param
Thanks stippi for noticing this oversight.
2014-06-25 15:39:07 -04:00
John Scipione 2ea139b8a3 BString docs: Document undocumented methods 2014-06-24 20:45:51 -04:00
John Scipione c4b9309a99 Update Support Kit docs, add \since
Also add preliminary documentation for BObjectList.
2014-06-24 19:30:54 -04:00
Ingo Weinhold 0d8b44e25b BDataIO: Add methods {Read,Write}Exactly() 2014-06-23 22:58:15 +02:00
Ingo Weinhold 98759fe6e6 BDataIO: Provide default implementations for Read()/Write()
This makes the interface somewhat more suitable for unidirectional use,
since one doesn't have to implement the other, not needed method.
2014-06-23 22:58:14 +02:00
Pawel Dziepak d0f2d8282f Merge branch 'scheduler'
Conflicts:
	build/jam/packages/Haiku
	headers/os/kernel/OS.h
	headers/os/opengl/GLRenderer.h
	headers/private/shared/cpu_type.h
	src/add-ons/kernel/drivers/power/acpi_battery/acpi_battery.h
	src/bin/sysinfo.cpp
	src/bin/top.c
	src/system/kernel/arch/x86/arch_system_info.cpp
	src/system/kernel/port.cpp
2014-01-17 04:06:15 +01:00
Ingo Weinhold 418c3fce24 Add get_*architecture*() API docs 2013-11-19 02:05:36 +01:00
Pawel Dziepak d929eb20ba docs: Update atomic_*() functions documentation 2013-11-05 22:54:25 +01:00
Adrien Destugues 6ec9625a36 Fix mismatched prototypes in the Haiku Book. 2013-10-04 16:56:59 +02:00
Niels Sascha Reedijk 0e1ec24ac0 Merge all the documentation from Archivable.h together 2013-09-29 11:48:33 +02:00
Niels Sascha Reedijk b7235efc80 Update support kit documentation to the latest changes on trunk
SetSubDirSupportedPlatformsBeOSCompatible ;
2013-09-29 11:48:33 +02:00
John Scipione 8e13dec040 Correction in the BStopWatch contructor docs 2013-02-18 19:47:25 -05:00
John Scipione db616065fa Update BStopWatch documentation 2013-02-18 19:39:34 -05: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 41611c9c5e Assign class docs for app and support to libbe group, not libroot 2013-02-07 15:04:05 -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 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
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
John Scipione 6ac7032dc6 Update the style of the Haiku Book to resemble the User Guide.
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
2011-11-02 08:36:02 +00:00
Adrien Destugues a33f8fbdec Merge work by John Scipione on the Haiku Book.
* 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
2011-08-09 21:46:13 +00:00
Joachim Seemer 36883d1e5b Fixing some typos, found by John Scipione and some by myself.
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@41361 a95241bf-73f2-0310-859d-f6bbb57e9c96
2011-05-07 05:58:20 +00:00
Adrien Destugues 2d14fc1b97 Major improvement to the support kit introduction, done as part of gci by InsDel (Thanks!).
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
2010-12-01 19:40:02 +00:00
Alex Wilson a46d62a268 Fix some typos in archiving documentation.
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@39054 a95241bf-73f2-0310-859d-f6bbb57e9c96
2010-10-23 01:51:37 +00:00
Alex Wilson 886c23bf8b Update doxygen docs for recent changes to BArchivable, also document the BArchiver and BUnarchiver classes, and add a not in compatibility.dox.
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@38035 a95241bf-73f2-0310-859d-f6bbb57e9c96
2010-08-11 22:09:14 +00:00
Niels Sascha Reedijk ae15171716 Update the SupportDefs documentation for several changes and document the atomic_* functions.
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@35148 a95241bf-73f2-0310-859d-f6bbb57e9c96
2010-01-18 23:14:46 +00:00
Niels Sascha Reedijk 445e975fda Correct typo. Fix bug #1548
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@22543 a95241bf-73f2-0310-859d-f6bbb57e9c96
2007-10-13 22:13:42 +00:00
Niels Sascha Reedijk 99b3aeed2d git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@21837 a95241bf-73f2-0310-859d-f6bbb57e9c96 2007-08-06 14:28:40 +00:00
Niels Sascha Reedijk 55f7db1bd9 Update according to the latest guideline changes. These files already
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
2007-08-06 09:32:27 +00:00
Niels Sascha Reedijk e3c5ca8539 Patch by Thom Holwerda. Proofreading.
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@21318 a95241bf-73f2-0310-859d-f6bbb57e9c96
2007-06-04 06:37:04 +00:00
Niels Sascha Reedijk 37503f54ec Technical proofreading by David Weizades.
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@21264 a95241bf-73f2-0310-859d-f6bbb57e9c96
2007-05-29 15:24:25 +00:00
Niels Sascha Reedijk dc84754eef Patch by Thom Holwerda:
"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
2007-05-28 12:18:49 +00:00
Niels Sascha Reedijk 5dee3b1245 Initial version of the TLS documentation.
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@21226 a95241bf-73f2-0310-859d-f6bbb57e9c96
2007-05-24 11:13:20 +00:00