Commit Graph

14 Commits

Author SHA1 Message Date
John Scipione
95faf2ce54 Minor doc changes 2014-12-18 20:45:25 -05:00
John Scipione
ac9714d8a4 Update App Kit Documentation.
The biggest change is the addition of \since to each method. I've gone
through old versions of the BeBook and documented what version of BeOS
each method was introduced in. I'm only counting production releases
so I'm starting with BeOS R3 ignoring all DR and PR releases. Likewise,
all methods new to Haiku are listed as being introduced \since Haiku R1
ignoring alpha releases.
2014-06-11 16:25:57 -04: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
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
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
Niels Sascha Reedijk
da3abc7c16 Handler.dox:
- 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
2008-03-08 15:11:39 +00:00
Niels Sascha Reedijk
a7f59ef8eb Fix the description for StartWatching() after a hint from Axel. There are two different behaviours for both overloaded variants. (which is bad, IMO)
*waves at Axel*

git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@23443 a95241bf-73f2-0310-859d-f6bbb57e9c96
2008-01-12 16:57:50 +00:00
Niels Sascha Reedijk
3f56983aa8 Small typo
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@23169 a95241bf-73f2-0310-859d-f6bbb57e9c96
2007-12-27 13:19:45 +00:00
Niels Sascha Reedijk
301744b8ac Phase I of the BHandler documentation.
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@23168 a95241bf-73f2-0310-859d-f6bbb57e9c96
2007-12-27 13:17:20 +00:00