Aren
/
haiku
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
46,228 Commits 9 Branches 0 Tags 473 MiB
Commit Graph

39 Commits

Author SHA1 Message Date
John Scipione 880e147bd9 Node Monitor documentation updates to stop_watching(). 
* 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.
 2013-03-04 19:24:31 -05:00
John Scipione 5dd0761042 Move BVolumeRoster docs to Haiku Book. 
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.
 2013-02-22 18:11:14 -05:00
John Scipione 9d5f5318a5 Move BVolume docs to the Haiku book 2013-02-21 20:15:53 -05:00
John Scipione 7635a303a2 SymLink.h not Symlink.h 2013-02-21 20:14:58 -05:00
John Scipione 434716ced8 Add BSymLink class docs to Haiku Book 2013-02-20 16:20:53 -05:00
John Scipione 29f51b3431 Set brief for desc of Path.h Query.h Resources.h and Statable.h 2013-02-19 19:25:04 -05:00
John Scipione 5bff846db2 Move BStatable docs to Haiku Book. 2013-02-19 19:07:15 -05:00
John Scipione 6d5fae2a5a Move resources docs to Haiku Book 
* 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.
 2013-02-18 18:14:10 -05: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
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
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
John Scipione a93a16151d Fix doxygen warnings, enums can only be in 1 group 2013-02-07 15:52:07 -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 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 5e6540723d Update BFilePanel docs, especially detailed description and constructor 2013-01-15 23:07:12 -05: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 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 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
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
John Scipione a92e17b124 Fix copyright line to Haiku, Inc. in Directory.dox and a few more small fixes. 2011-12-18 21:26:02 -05:00
John Scipione 2ac1eb67b3 Move the doxygen documentation comments from src/kits/storage/Directory.cpp to docs/user/storage/Directory.dox and update it both the language, fix a few errors, and bring the syntax up to snuff. The documentation for the BDirectory class is now added to the Haiku Book. 2011-12-18 18:53:46 -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
Niels Sascha Reedijk 7f1880dc0e Apply patch for ticket #8008: 
* 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
 2011-10-29 22:02:52 +00:00
Adrien Destugues 07658a130e Add some documentation for find_directory. This is very incomplete yet. 
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@42694 a95241bf-73f2-0310-859d-f6bbb57e9c96
 2011-08-27 09:15:50 +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