#
da4dbfa4 |
|
28-Dec-2023 |
PulkoMandy <pulkomandy@pulkomandy.tk> |
API docs: document KernelExport.h and overview of synchronization primitives. Change-Id: Ic3853bf103710f289a32f43f5fb1beb79bca0b9f Reviewed-on: https://review.haiku-os.org/c/haiku/+/7245 Reviewed-by: waddlesplash <waddlesplash@gmail.com>
|
#
4958c5d7 |
|
24-Jun-2023 |
Niels Sascha Reedijk <niels.reedijk@gmail.com> |
HaikuBook: fix some errors and warnings during documentation generation Change-Id: Ib6b876ff83aeba0d2346990ab2e9869cbf519284 Reviewed-on: https://review.haiku-os.org/c/haiku/+/6641 Tested-by: Commit checker robot <no-reply+buildbot@haiku-os.org> Reviewed-by: Adrien Destugues <pulkomandy@pulkomandy.tk>
|
#
c97648aa |
|
15-Feb-2023 |
Augustin Cavalier <waddlesplash@gmail.com> |
docs/user: Use Doxygen's internal search system. Fixes #17209.
|
#
f7b2278e |
|
15-Feb-2023 |
Augustin Cavalier <waddlesplash@gmail.com> |
docs/user: Update Doxyfile to Doxygen 1.9.6. Automated conversion via "doxygen -u". No changes to settings otherwise.
|
#
ec7d71e6 |
|
13-Sep-2021 |
Niels Sascha Reedijk <niels.reedijk@gmail.com> |
NetServices: Add skeleton BHttpSession class and its documentation Change-Id: Ia8a35588422908f6fe9b839ce239fb478baf298b
|
#
f54a5a68 |
|
12-Sep-2021 |
Niels Sascha Reedijk <niels.reedijk@gmail.com> |
HaikuBook: Prepare for newer Network Services Kit docs Change-Id: Ib2cc458f9121cb78250a643affc0933512e65bc8
|
#
0b86520c |
|
06-Sep-2021 |
Niels Sascha Reedijk <niels.reedijk@gmail.com> |
BString: add support for move semantics with C++11 and up. This implements the "rule of 5" for this type. While the copy operation for BString was already using shallow copies of the underlying data, this change further optimizes moving the data from one object to another. While it is not the intention to implement move semantics to all types in the legacy Haiku/Be kits, data types like BString are good candidates, because move operations are often useful when working with data within an application. In this implementation, the internal data of the string object will be set to NULL, thus leaving an empty string. Change-Id: I16bf9424f9b17f622b0b57659b80628e18760288 Reviewed-on: https://review.haiku-os.org/c/haiku/+/4428 Reviewed-by: Jérôme Duval <jerome.duval@gmail.com>
|
#
094b8dcf |
|
29-Jan-2021 |
Niels Sascha Reedijk <niels.reedijk@gmail.com> |
HaikuBook: housekeeping of the netservices documentation Change-Id: I6f9444665e061047bfb024ac0274b69fa1396912
|
#
42dcaf37 |
|
08-Oct-2020 |
Niels Sascha Reedijk <niels.reedijk@gmail.com> |
HaikuBook: Hide BLaunchRoster and BToolTip documentation from book These two classes are not yet in the public API, as such they are hidden behind the INTERNAL conditional variable. Change-Id: I4ac204a600715937ef99d8ff56c4026d06abec3f Reviewed-on: https://review.haiku-os.org/c/haiku/+/3305 Reviewed-by: waddlesplash <waddlesplash@gmail.com>
|
#
d458e592 |
|
27-Sep-2020 |
Niels Sascha Reedijk <niels.reedijk@gmail.com> |
HaikuBook: Apply layout customizations after default Doxygen stylesheet Previously the 'book.css' file was applied as the sole stylesheet for the Doxygen generated documentation. This stylesheet now applies it as a secondary stylesheet to override Doxygen's defaults. The main advantage is that when Doxygen adds new features, they will now be styled by default. I did my best to clean up the book.css file, though it is not unlikely that there still is a lot of duplicate CSS. For now though, the output looks mostly the same, the code blocks no longer have an empty line between each of the lines and the tooltip text - while not working - are no longer visible on the bottom of the page. Change-Id: Ia50915245ecd981843d0d8ec42e362b538187920 Reviewed-on: https://review.haiku-os.org/c/haiku/+/3269 Reviewed-by: Adrien Destugues <pulkomandy@gmail.com>
|
#
02e45e32 |
|
01-Mar-2020 |
Niels Sascha Reedijk <niels.reedijk@gmail.com> |
HaikuBook: Initial documentation for BNotification The implementation file contained some documentation. This has been moved to the Haiku Book (and is rewritten in most cases). The documentation gives some insight on how the notification_server works. Change-Id: I82bafcf57101d4882bdf07e7f731df9cd8adc861 Reviewed-on: https://review.haiku-os.org/c/haiku/+/2299 Reviewed-by: Adrien Destugues <pulkomandy@gmail.com>
|
#
22beb3fd |
|
01-Mar-2020 |
Niels Sascha Reedijk <niels.reedijk@gmail.com> |
Haikubook: update doxygen configuration with doxygen 1.18.17
|
#
ff1ee776 |
|
01-Mar-2020 |
Niels Sascha Reedijk <niels.reedijk@gmail.com> |
HaikuBook: fix part of the warnings marked by Doxygen I spotted some warnings when I upgraded from Doxygen 1.18.13 to 1.18.17. The new warnings are useful, they point out imbalances in grouping, as well as unclosed comment blocks. Coincidentally, this fixes #13338
|
#
95c9effd |
|
25-Dec-2017 |
Augustin Cavalier <waddlesplash@gmail.com> |
Migrate the BMailComponent docs to the Haiku Book. I've updated the docs to match the current BMailComponent, documented new functions, and cleaned up the MailComponent.h file to at least somewhat match our coding style. First in a series (there are 3 more old API docs on the Mail Kit in that "Public API" folder.)
|
#
9d5b0fda |
|
01-Oct-2017 |
Augustin Cavalier <waddlesplash@gmail.com> |
docs/user: Upgrade to Doxygen 1.8.13. Also tweak the footer CSS a bit, and fix an unclosed comment in the fs_interface docs (spotted via a warning in Doxygen output.)
|
#
22423870 |
|
30-Sep-2017 |
Kacper Kasper <kacperkasper@gmail.com> |
docs/user: Update CSS for Doxygen 1.8.12.
|
#
f943fa46 |
|
26-May-2017 |
Andrew Lindesay <apl@lindesay.co.nz> |
JSON Parser : Documentation migration This commit migrates the JSON overview documentation that was recently added from Markdown to Doxygen.
|
#
8d38dd18 |
|
24-Jan-2017 |
Augustin Cavalier <waddlesplash@gmail.com> |
docs/user: Updates for Doxygen 1.8. Surprisingly, after disabling the new Markdown support in the Doxyfile, everything else pretty much worked out of the box. Only a number of CSS changes were needed to adapt. I wonder why nobody ever did this back in 2012 when 1.8 first came out...
|
#
b855c871 |
|
27-Apr-2016 |
John Scipione <jscipione@gmail.com> |
Add private app headers to Doxyfile needed for LaunchRoster which has gone private.
|
#
51362d85 |
|
06-Apr-2015 |
Augustin Cavalier <waddlesplash@gmail.com> |
Haiku Book: Doxyfile: eat __attribute__ directives. Without this, Doxygen attempts to parse __attribute__ directives and often outputs garbage instead of properly parsing them, so just exclude them from the documentation. Fixes some incorrect function listings in BString documentation and possibly more elsewhere.
|
#
9d6780b5 |
|
25-Mar-2015 |
Augustin Cavalier <waddlesplash@gmail.com> |
Haiku Book: disable class diagrams. The last time this was discussed on the ML, the consensus was that the text lists were nicer than the diagrams (with only one objection). For the minority that wants class diagrams, it's easy enough to reverse this one-line change.
|
#
b1a9f638 |
|
27-Jan-2015 |
John Scipione <jscipione@gmail.com> |
Add preliminary Net Kit intro by Philippe Houdoin From here: http://philippe.houdoin.free.fr/phil/beos/openbeos/network_kit/overview.html
|
#
29b7900e |
|
06-Jan-2015 |
Adrien Destugues <pulkomandy@gmail.com> |
Add BJoystick docs to the Haiku Book.
|
#
d87c6913 |
|
23-Dec-2014 |
John Scipione <jscipione@gmail.com> |
Add preliminary BToolTip docs
|
#
f36b3f9b |
|
08-Dec-2014 |
Niels Sascha Reedijk <niels.reedijk@gmail.com> |
Generate the Makefile for making docsets. Docset is an increasingly popular format that is used to generate an index for HTML documentation that can be viewed by specialized viewers such as Dash (on the Mac). The output can only be generated on a Mac currently. Enabling the DOCSET parameter will generate a Makefile in the html output directory, which can be used to generate the Docset itself. Enabling the Docset Makefile does not negatively impact other things, as such it seems safe to just enable it for whoever wants to build the docset on a mac.
|
#
847e14f0 |
|
27-Feb-2014 |
John Scipione <jscipione@gmail.com> |
Turn class diagrams back on
|
#
dba29137 |
|
05-Feb-2014 |
waddlesplash <ajcsweb@gmail.com> |
Tweaks to the API documentation * Update the Doxyfile for 1.7.6.1. Doxywizard reformatted the comments; that's why this change is so big * Disable graph inheritance trees; use "Inherits/Inherited by" lists instead (Doxygen has this on by default; I don't think it was intentional) * Shorten two subgroup names; helps with formatting in Doxygen 1.8 and looks cleaner * Moves the page footer ("The Haiku Book pre-R1...") be in a <footer> tag, and add a CSS rule for this tag * Disable XML output, no one is using it * Disable Microsoft IDL parsing, speeds up Doxygen a bit
|
#
72dfdc79 |
|
07-Nov-2013 |
waddlesplash <ajcsweb@gmail.com> |
Set INLINE_INHERITED_MEMB to NO. * "YES" causes all members of a class to be stuck in that class' page. * No need to do that, there's a "List all members" page. * This will make the docs a lot smaller and easier to read. Signed-off-by: John Scipione <jscipione@gmail.com>
|
#
4cf62172 |
|
04-Oct-2013 |
Adrien Destugues <pulkomandy@pulkomandy.tk> |
Document some classes for the Network Kit.
|
#
faeb2ff3 |
|
07-Feb-2013 |
John Scipione <jscipione@gmail.com> |
Move syslog.dox from support to posix and put it in libroot.so
|
#
820dca4d |
|
06-Feb-2013 |
John Scipione <jscipione@gmail.com> |
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.
|
#
3528f5bb |
|
19-Jan-2013 |
John Scipione <jscipione@gmail.com> |
Add BBitmapStream docs and translation kit stub
|
#
2b934bb6 |
|
14-Jan-2013 |
John Scipione <jscipione@gmail.com> |
Add BFilePanel and BRefFilter documentation
|
#
0abbcaaa |
|
14-Jan-2013 |
John Scipione <jscipione@gmail.com> |
Update Doxyfile to 1.7.5.1
|
#
ceaf7141 |
|
21-Dec-2012 |
John Scipione <jscipione@gmail.com> |
BDirectWindow class documentation fixes
|
#
b1b809ef |
|
21-Dec-2012 |
John Scipione <jscipione@gmail.com> |
Add preliminary DirectWindow documentation
|
#
8786818c |
|
18-Dec-2011 |
John Scipione <jscipione@gmail.com> |
Add documentation for the GameProducer class in the Game Kit. This documentation was provided by Omri Barak, a student participating in Google Code Initiative (GCI) 2011. Signed off by John Scipione Since this is the first class documented in the Game Kit I also added a reference to the Game Kit to the API docs front page.
|
#
4466b89c |
|
10-Nov-2011 |
John Scipione <jscipione@gmail.com> |
Add a section to the Haiku Book with a very special topic, the keyboard. This started off as just being a page to detail the key codes since I find myself constantly referencing the BeBook page on the subject and it is horribly broken. However, the page has grown to detail many of the keyboard related methods and constants defined in InterfaceDefs.h as well. A very long and detailed explanation of the key_map structure is included. git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@43230 a95241bf-73f2-0310-859d-f6bbb57e9c96
|
#
38a05774 |
|
02-Nov-2011 |
John Scipione <jscipione@gmail.com> |
Set SORT_MEMBERS_CTORS_1ST variable to YES in the Doxyfile so that constructor and destructor methods will get sorted before member methods in class documentation files. git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@43099 a95241bf-73f2-0310-859d-f6bbb57e9c96
|
#
6ac7032d |
|
02-Nov-2011 |
John Scipione <jscipione@gmail.com> |
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
|
#
7f1880dc |
|
29-Oct-2011 |
Niels Sascha Reedijk <niels.reedijk@gmail.com> |
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
|
#
1326b9d0 |
|
29-Oct-2011 |
Niels Sascha Reedijk <niels.reedijk@gmail.com> |
Apply the patch by jscipione on ticket #7994. * Update BScreen class style and variable names * Remove documentation from Screen.cpp file * Create Screen.dox documentation file git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@42984 a95241bf-73f2-0310-859d-f6bbb57e9c96
|
#
07658a13 |
|
27-Aug-2011 |
Adrien Destugues <pulkomandy@pulkomandy.ath.cx> |
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
|
#
a33f8fbd |
|
09-Aug-2011 |
Adrien Destugues <pulkomandy@pulkomandy.ath.cx> |
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
|
#
61a02f6d |
|
09-Aug-2011 |
Adrien Destugues <pulkomandy@pulkomandy.ath.cx> |
* Add the header file to doxygen, too * Fix copypaste error. git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@42607 a95241bf-73f2-0310-859d-f6bbb57e9c96
|
#
6ec25bba |
|
30-Nov-2010 |
Adrien Destugues <pulkomandy@pulkomandy.ath.cx> |
Add documentation for BBox class, done by Clark Gaebel as part of GCI 2010. I did rework the text a little. I would like to get some careful review for this. Nielx put out the (valid) concern that he's not confident in random students with no previous Haiku experience to write the API reference. I'd like to know if I should put online more of these tasks, or if I should stop now because the quality is too low. git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@39686 a95241bf-73f2-0310-859d-f6bbb57e9c96
|
#
cc19e7c0 |
|
22-Oct-2010 |
Alex Wilson <yourpalal2@gmail.com> |
Add initial documentation for Layout API, not everything is documented, and it's not perfect, but its time to commit this. git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@39055 a95241bf-73f2-0310-859d-f6bbb57e9c96
|
#
0a4e27c5 |
|
04-Aug-2010 |
Adrien Destugues <pulkomandy@pulkomandy.ath.cx> |
* Fixed the main page entry for locale kit * Also parse the actual code to get the methods shown in the classes, inheritance diagrams, and all that stuff * Add some docs on date formatting to BLocale git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@37925 a95241bf-73f2-0310-859d-f6bbb57e9c96
|
#
e9fd63ec |
|
03-Aug-2010 |
Adrien Destugues <pulkomandy@pulkomandy.ath.cx> |
* Fix some outdated information in documentation files * Add a very small part of documentation about the Locale Kit. git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@37873 a95241bf-73f2-0310-859d-f6bbb57e9c96
|
#
702a1e72 |
|
01-Feb-2009 |
Niels Sascha Reedijk <niels.reedijk@gmail.com> |
Tweak looks of API documentation. 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
|
#
301744b8 |
|
27-Dec-2007 |
Niels Sascha Reedijk <niels.reedijk@gmail.com> |
Phase I of the BHandler documentation. git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@23168 a95241bf-73f2-0310-859d-f6bbb57e9c96
|
#
8a446182 |
|
08-Aug-2007 |
Niels Sascha Reedijk <niels.reedijk@gmail.com> |
Create framework for Application Kit. git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@21851 a95241bf-73f2-0310-859d-f6bbb57e9c96
|
#
cb15abc7 |
|
12-Jun-2007 |
Niels Sascha Reedijk <niels.reedijk@gmail.com> |
Update to Doxygen 1.5.2. 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
|
#
81071f5e |
|
16-Apr-2007 |
Niels Sascha Reedijk <niels.reedijk@gmail.com> |
Large documentation update: - 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
|
#
3458a335 |
|
03-Apr-2007 |
Ingo Weinhold <ingo_weinhold@gmx.de> |
Started documenting the FS API a bit. git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@20544 a95241bf-73f2-0310-859d-f6bbb57e9c96
|
#
a38ee20f |
|
19-Mar-2007 |
Niels Sascha Reedijk <niels.reedijk@gmail.com> |
Initial revision of the API documentation guidelines up for discussion. DataIO.dox and List.dox conform to these guidelines. git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@20392 a95241bf-73f2-0310-859d-f6bbb57e9c96
|
#
89e18a51 |
|
02-Mar-2007 |
Niels Sascha Reedijk <niels.reedijk@gmail.com> |
* Take a document on compatibility from the Haiku website (experimenting with pages) - Originally written by Ingo and updated by others, I have permission from Ingo. * 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
|
#
089b7ad4 |
|
28-Dec-2006 |
Niels Sascha Reedijk <niels.reedijk@gmail.com> |
Some more work on the Doxygen version of the haiku_book. 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
|
#
515dc588 |
|
27-Dec-2006 |
Niels Sascha Reedijk <niels.reedijk@gmail.com> |
Play around with doxygen a bit more, since I don't want to give up on it just yet. 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
|
#
d419ca3b |
|
11-Sep-2006 |
Niels Sascha Reedijk <niels.reedijk@gmail.com> |
Update API documentation and Doxyfile to improve the output. git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@18822 a95241bf-73f2-0310-859d-f6bbb57e9c96
|
#
e932ec1a |
|
11-Sep-2006 |
Niels Sascha Reedijk <niels.reedijk@gmail.com> |
Revert earlier removal. git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@18801 a95241bf-73f2-0310-859d-f6bbb57e9c96
|
#
61da80a8 |
|
10-Sep-2006 |
Niels Sascha Reedijk <niels.reedijk@gmail.com> |
This documentation is converted to docbook. Check the trunk/src/documentation/haiku_book subdir. git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@18791 a95241bf-73f2-0310-859d-f6bbb57e9c96
|
#
7e3d3594 |
|
14-Mar-2005 |
Axel Dörfler <axeld@pinc-software.de> |
Added support kit and some POSIX headers to the doxyfile. git-svn-id: file:///srv/svn/repos/haiku/trunk/current@11735 a95241bf-73f2-0310-859d-f6bbb57e9c96
|
#
700c9b5d |
|
01-Jun-2004 |
Waldemar Kornewald <wkornew@nowhere.fake> |
Added initial PPP API documentation. git-svn-id: file:///srv/svn/repos/haiku/trunk/current@7729 a95241bf-73f2-0310-859d-f6bbb57e9c96
|
#
0524a6a8 |
|
11-Mar-2003 |
mahlzeit <mahlzeit@nowhere.fake> |
Added Midi Kit end-user documentation. git-svn-id: file:///srv/svn/repos/haiku/trunk/current@2881 a95241bf-73f2-0310-859d-f6bbb57e9c96
|
#
51362d85d8a9c44ebb5e09049a3eb3596399ba45 |
|
06-Apr-2015 |
Augustin Cavalier <waddlesplash@gmail.com> |
Haiku Book: Doxyfile: eat __attribute__ directives. Without this, Doxygen attempts to parse __attribute__ directives and often outputs garbage instead of properly parsing them, so just exclude them from the documentation. Fixes some incorrect function listings in BString documentation and possibly more elsewhere.
|
#
9d6780b58759762298e2a36480e3ea62751e60f7 |
|
25-Mar-2015 |
Augustin Cavalier <waddlesplash@gmail.com> |
Haiku Book: disable class diagrams. The last time this was discussed on the ML, the consensus was that the text lists were nicer than the diagrams (with only one objection). For the minority that wants class diagrams, it's easy enough to reverse this one-line change.
|
#
b1a9f638daa96471328f57f385ff17a9dee760b2 |
|
27-Jan-2015 |
John Scipione <jscipione@gmail.com> |
Add preliminary Net Kit intro by Philippe Houdoin From here: http://philippe.houdoin.free.fr/phil/beos/openbeos/network_kit/overview.html
|
#
29b7900ec85646d7e3cf3356d234369c6084d038 |
|
06-Jan-2015 |
Adrien Destugues <pulkomandy@gmail.com> |
Add BJoystick docs to the Haiku Book.
|
#
d87c6913ec17d6d02eac75c08f8bde22a4cb67f4 |
|
23-Dec-2014 |
John Scipione <jscipione@gmail.com> |
Add preliminary BToolTip docs
|
#
f36b3f9b3e18f49b640064af67b31797d4a3612b |
|
08-Dec-2014 |
Niels Sascha Reedijk <niels.reedijk@gmail.com> |
Generate the Makefile for making docsets. Docset is an increasingly popular format that is used to generate an index for HTML documentation that can be viewed by specialized viewers such as Dash (on the Mac). The output can only be generated on a Mac currently. Enabling the DOCSET parameter will generate a Makefile in the html output directory, which can be used to generate the Docset itself. Enabling the Docset Makefile does not negatively impact other things, as such it seems safe to just enable it for whoever wants to build the docset on a mac.
|
#
847e14f0021c0ff9c5674fe59d84a0a931283347 |
|
27-Feb-2014 |
John Scipione <jscipione@gmail.com> |
Turn class diagrams back on
|
#
dba29137b2f148451e5c6e5ff59254c3262dd5aa |
|
05-Feb-2014 |
waddlesplash <ajcsweb@gmail.com> |
Tweaks to the API documentation * Update the Doxyfile for 1.7.6.1. Doxywizard reformatted the comments; that's why this change is so big * Disable graph inheritance trees; use "Inherits/Inherited by" lists instead (Doxygen has this on by default; I don't think it was intentional) * Shorten two subgroup names; helps with formatting in Doxygen 1.8 and looks cleaner * Moves the page footer ("The Haiku Book pre-R1...") be in a <footer> tag, and add a CSS rule for this tag * Disable XML output, no one is using it * Disable Microsoft IDL parsing, speeds up Doxygen a bit
|
#
72dfdc7940ae7700ccb02813055757a3af6e00d4 |
|
07-Nov-2013 |
waddlesplash <ajcsweb@gmail.com> |
Set INLINE_INHERITED_MEMB to NO. * "YES" causes all members of a class to be stuck in that class' page. * No need to do that, there's a "List all members" page. * This will make the docs a lot smaller and easier to read. Signed-off-by: John Scipione <jscipione@gmail.com>
|
#
4cf6217227d75dcaed5bea03a9e61d255274988f |
|
04-Oct-2013 |
Adrien Destugues <pulkomandy@pulkomandy.tk> |
Document some classes for the Network Kit.
|
#
faeb2ff33138a701f6db87e4d8c017d5c5f2285f |
|
07-Feb-2013 |
John Scipione <jscipione@gmail.com> |
Move syslog.dox from support to posix and put it in libroot.so
|
#
820dca4df6c7bf955c46e8f6521b9408f50b2900 |
|
06-Feb-2013 |
John Scipione <jscipione@gmail.com> |
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.
|
#
3528f5bb69184d6b3da7201c51c56068fe907f04 |
|
19-Jan-2013 |
John Scipione <jscipione@gmail.com> |
Add BBitmapStream docs and translation kit stub
|
#
2b934bb6aee4cdd891e5b727e0c0e66897816229 |
|
14-Jan-2013 |
John Scipione <jscipione@gmail.com> |
Add BFilePanel and BRefFilter documentation
|
#
0abbcaaa35f3cadfb0ac251270a484955ffe050e |
|
14-Jan-2013 |
John Scipione <jscipione@gmail.com> |
Update Doxyfile to 1.7.5.1
|
#
ceaf7141fa163a6cdad59be5112f84eb16acb39a |
|
21-Dec-2012 |
John Scipione <jscipione@gmail.com> |
BDirectWindow class documentation fixes
|
#
b1b809ef2761d1832e0c7c5b19005c7a0abdd10b |
|
21-Dec-2012 |
John Scipione <jscipione@gmail.com> |
Add preliminary DirectWindow documentation
|
#
8786818cf2b7afd3ea9979f06d3ead55cfef041b |
|
18-Dec-2011 |
John Scipione <jscipione@gmail.com> |
Add documentation for the GameProducer class in the Game Kit. This documentation was provided by Omri Barak, a student participating in Google Code Initiative (GCI) 2011. Signed off by John Scipione Since this is the first class documented in the Game Kit I also added a reference to the Game Kit to the API docs front page.
|
#
4466b89c65970de4c7236ac87faa2bee4589f413 |
|
10-Nov-2011 |
John Scipione <jscipione@gmail.com> |
Add a section to the Haiku Book with a very special topic, the keyboard. This started off as just being a page to detail the key codes since I find myself constantly referencing the BeBook page on the subject and it is horribly broken. However, the page has grown to detail many of the keyboard related methods and constants defined in InterfaceDefs.h as well. A very long and detailed explanation of the key_map structure is included. git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@43230 a95241bf-73f2-0310-859d-f6bbb57e9c96
|
#
38a0577422cc2c7db8980e54ccc0c4a6c1fe592b |
|
02-Nov-2011 |
John Scipione <jscipione@gmail.com> |
Set SORT_MEMBERS_CTORS_1ST variable to YES in the Doxyfile so that constructor and destructor methods will get sorted before member methods in class documentation files. git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@43099 a95241bf-73f2-0310-859d-f6bbb57e9c96
|
#
6ac7032dc66744139522bdef3fab49d4e894a84a |
|
02-Nov-2011 |
John Scipione <jscipione@gmail.com> |
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
|
#
7f1880dc0ed378e10f46bf7dd6d697dcf9ffd9fe |
|
29-Oct-2011 |
Niels Sascha Reedijk <niels.reedijk@gmail.com> |
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
|
#
1326b9d0b48dd37031ac17a31f77f092fd2afd73 |
|
29-Oct-2011 |
Niels Sascha Reedijk <niels.reedijk@gmail.com> |
Apply the patch by jscipione on ticket #7994. * Update BScreen class style and variable names * Remove documentation from Screen.cpp file * Create Screen.dox documentation file git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@42984 a95241bf-73f2-0310-859d-f6bbb57e9c96
|
#
07658a130ee68ac167d6ad5b00289fd0a540c445 |
|
27-Aug-2011 |
Adrien Destugues <pulkomandy@pulkomandy.ath.cx> |
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
|
#
a33f8fbdec035ff322cc1ef364877a3092e99a09 |
|
09-Aug-2011 |
Adrien Destugues <pulkomandy@pulkomandy.ath.cx> |
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
|
#
61a02f6d991274728e13858b38732f242eaf129d |
|
09-Aug-2011 |
Adrien Destugues <pulkomandy@pulkomandy.ath.cx> |
* Add the header file to doxygen, too * Fix copypaste error. git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@42607 a95241bf-73f2-0310-859d-f6bbb57e9c96
|
#
6ec25bba48828d6d3e51e768d766aed4d97a08c5 |
|
30-Nov-2010 |
Adrien Destugues <pulkomandy@pulkomandy.ath.cx> |
Add documentation for BBox class, done by Clark Gaebel as part of GCI 2010. I did rework the text a little. I would like to get some careful review for this. Nielx put out the (valid) concern that he's not confident in random students with no previous Haiku experience to write the API reference. I'd like to know if I should put online more of these tasks, or if I should stop now because the quality is too low. git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@39686 a95241bf-73f2-0310-859d-f6bbb57e9c96
|
#
cc19e7c0ffc8b52c397d854c894193b3e69c022b |
|
22-Oct-2010 |
Alex Wilson <yourpalal2@gmail.com> |
Add initial documentation for Layout API, not everything is documented, and it's not perfect, but its time to commit this. git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@39055 a95241bf-73f2-0310-859d-f6bbb57e9c96
|
#
0a4e27c50bf15b9ebf5831513c1a598acf8e0516 |
|
04-Aug-2010 |
Adrien Destugues <pulkomandy@pulkomandy.ath.cx> |
* Fixed the main page entry for locale kit * Also parse the actual code to get the methods shown in the classes, inheritance diagrams, and all that stuff * Add some docs on date formatting to BLocale git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@37925 a95241bf-73f2-0310-859d-f6bbb57e9c96
|
#
e9fd63ec7c895097106c925b73753e152b1c6b0b |
|
03-Aug-2010 |
Adrien Destugues <pulkomandy@pulkomandy.ath.cx> |
* Fix some outdated information in documentation files * Add a very small part of documentation about the Locale Kit. git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@37873 a95241bf-73f2-0310-859d-f6bbb57e9c96
|
#
702a1e7241145d176c05642e59c99772d53fc010 |
|
01-Feb-2009 |
Niels Sascha Reedijk <niels.reedijk@gmail.com> |
Tweak looks of API documentation. 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
|
#
301744b8ac24aa89d079ae8590acc323057ab6a6 |
|
27-Dec-2007 |
Niels Sascha Reedijk <niels.reedijk@gmail.com> |
Phase I of the BHandler documentation. git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@23168 a95241bf-73f2-0310-859d-f6bbb57e9c96
|
#
8a446182252e58e75cbe8d2fb715abfc1fc8f9ad |
|
08-Aug-2007 |
Niels Sascha Reedijk <niels.reedijk@gmail.com> |
Create framework for Application Kit. git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@21851 a95241bf-73f2-0310-859d-f6bbb57e9c96
|
#
cb15abc767c866deefef856f714158f22627ba0a |
|
12-Jun-2007 |
Niels Sascha Reedijk <niels.reedijk@gmail.com> |
Update to Doxygen 1.5.2. 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
|
#
81071f5e8a19a909d8178fae1f1ebf5eb7388f56 |
|
16-Apr-2007 |
Niels Sascha Reedijk <niels.reedijk@gmail.com> |
Large documentation update: - 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
|
#
3458a335ab23b6fc6d280d721a6a15b08b11fcb4 |
|
03-Apr-2007 |
Ingo Weinhold <ingo_weinhold@gmx.de> |
Started documenting the FS API a bit. git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@20544 a95241bf-73f2-0310-859d-f6bbb57e9c96
|
#
a38ee20f9953dc81c1ff305b9d3c8fd7e9e5e029 |
|
19-Mar-2007 |
Niels Sascha Reedijk <niels.reedijk@gmail.com> |
Initial revision of the API documentation guidelines up for discussion. DataIO.dox and List.dox conform to these guidelines. git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@20392 a95241bf-73f2-0310-859d-f6bbb57e9c96
|
#
89e18a513c88a244eadb707a1a036d705692d16b |
|
02-Mar-2007 |
Niels Sascha Reedijk <niels.reedijk@gmail.com> |
* Take a document on compatibility from the Haiku website (experimenting with pages) - Originally written by Ingo and updated by others, I have permission from Ingo. * 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
|
#
089b7ad4c6c63409b1751d0cb77d00c30851daec |
|
28-Dec-2006 |
Niels Sascha Reedijk <niels.reedijk@gmail.com> |
Some more work on the Doxygen version of the haiku_book. 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
|
#
515dc58881afdf23715b9834f6a50f845307fc8e |
|
27-Dec-2006 |
Niels Sascha Reedijk <niels.reedijk@gmail.com> |
Play around with doxygen a bit more, since I don't want to give up on it just yet. 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
|
#
d419ca3b7bf7e42c137fc3ea9b74eeaf7e653d49 |
|
11-Sep-2006 |
Niels Sascha Reedijk <niels.reedijk@gmail.com> |
Update API documentation and Doxyfile to improve the output. git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@18822 a95241bf-73f2-0310-859d-f6bbb57e9c96
|
#
e932ec1af2d1d61709bbe320b7d96b8d5c0578cb |
|
11-Sep-2006 |
Niels Sascha Reedijk <niels.reedijk@gmail.com> |
Revert earlier removal. git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@18801 a95241bf-73f2-0310-859d-f6bbb57e9c96
|
#
61da80a80ab569b412457e5e3e9a89d2c10ed333 |
|
10-Sep-2006 |
Niels Sascha Reedijk <niels.reedijk@gmail.com> |
This documentation is converted to docbook. Check the trunk/src/documentation/haiku_book subdir. git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@18791 a95241bf-73f2-0310-859d-f6bbb57e9c96
|
#
7e3d359491217926506cc6c73e8bc1203cd5c1cc |
|
14-Mar-2005 |
Axel Dörfler <axeld@pinc-software.de> |
Added support kit and some POSIX headers to the doxyfile. git-svn-id: file:///srv/svn/repos/haiku/trunk/current@11735 a95241bf-73f2-0310-859d-f6bbb57e9c96
|
#
700c9b5dad153bf7dd75286126ba276fdc9e2f44 |
|
01-Jun-2004 |
Waldemar Kornewald <wkornew@nowhere.fake> |
Added initial PPP API documentation. git-svn-id: file:///srv/svn/repos/haiku/trunk/current@7729 a95241bf-73f2-0310-859d-f6bbb57e9c96
|
#
0524a6a89db566881e3acf3cee9b39614d22a511 |
|
11-Mar-2003 |
mahlzeit <mahlzeit@nowhere.fake> |
Added Midi Kit end-user documentation. git-svn-id: file:///srv/svn/repos/haiku/trunk/current@2881 a95241bf-73f2-0310-859d-f6bbb57e9c96
|