diff --git a/docs/user/Doxyfile b/docs/user/Doxyfile index 98ae11c616..0d1e86e0f1 100644 --- a/docs/user/Doxyfile +++ b/docs/user/Doxyfile @@ -938,6 +938,7 @@ INPUT = . \ ../../headers/os/game \ ../../headers/os/interface \ ../../headers/private/interface/ToolTip.h \ + ../../headers/os/kernel/fs_query.h \ ../../headers/private/kernel/condition_variable.h \ ../../headers/os/locale \ ../../headers/os/mail \ @@ -949,6 +950,7 @@ INPUT = . \ ../../headers/os/storage \ ../../headers/os/support \ ../../headers/os/translation \ + ../../headers/posix/dlfcn.h \ ../../headers/posix/syslog.h \ ../../headers/posix/unistd.h \ ../../src/kits/game/GameProducer.h diff --git a/docs/user/book.dox b/docs/user/book.dox index fd6e70104c..c0340b4ebf 100644 --- a/docs/user/book.dox +++ b/docs/user/book.dox @@ -117,6 +117,9 @@ - BKeyStore + \defgroup device Device Kit + \brief The Device Kit provides access to devices such as joysticks and serial ports. + \defgroup game Game Kit \brief The Game Kit provides classes for producing game sounds and working with full screen apps. @@ -125,6 +128,10 @@ \defgroup interface Interface Kit \brief API for displaying a graphical user interface. + \defgroup kernel Kernel Kit + \brief The Kernel Kit provides low-level APIs mainly of use for writing device drivers and + kernel modules. + \defgroup locale Locale Kit \brief Collection of classes for localizing applications. @@ -565,9 +572,6 @@ snooze_until(time - Latency(), B_SYSTEM_TIMEBASE); \defgroup libbe Main C++ library (libbe.so) - - \defgroup libroot C and POSIX standard functions and extensions (libroot.so) - \brief Implements the C and POSIX standard libraries. */ ///// Subgroups ///// diff --git a/docs/user/drivers/KernelExport.dox b/docs/user/drivers/KernelExport.dox index 7e2f911a4f..a9fc65b007 100644 --- a/docs/user/drivers/KernelExport.dox +++ b/docs/user/drivers/KernelExport.dox @@ -192,12 +192,14 @@ /*! \fn status_t add_timer(timer *t, timer_hook hook, bigtime_t period, int32 flags) \ingroup timers - \brief Schedule a timer to call the \ref hook function periodically or at a specified time. + \brief Schedule a timer to call the \a hook function periodically or at a specified time. - \param flags If B_ONE_SHOT_ABSOLUTE_TIMER, use the period as a date when the hook should be - called. Otherwise, use it as a period to call the hook repeatedly. - \param flags If B_TIMER_USE_TIMER_STRUCT_TIMES, use the period defined by \ref t instead of - \ref period. + \param[out] t Timer handler, for use in \ref cancel_timer. + \param flags + \li If B_ONE_SHOT_ABSOLUTE_TIMER, use the \a period as a date when the hook should be + called. Otherwise, use it as a period to call the hook repeatedly. + \li If B_TIMER_USE_TIMER_STRUCT_TIMES, use the period defined by \a t instead of + \a period. */ /*! diff --git a/docs/user/game/GameSound.dox b/docs/user/game/GameSound.dox index 45c72d7cab..56c1a5accd 100644 --- a/docs/user/game/GameSound.dox +++ b/docs/user/game/GameSound.dox @@ -252,3 +252,4 @@ \since BeOS R4.5 */ +//! @} diff --git a/docs/user/interface/AffineTransform.dox b/docs/user/interface/AffineTransform.dox index 0cc759cc68..65002b6706 100644 --- a/docs/user/interface/AffineTransform.dox +++ b/docs/user/interface/AffineTransform.dox @@ -90,9 +90,6 @@ \fn BAffineTransform::BAffineTransform() \brief Undocumented public method - \return Undocumented - \retval Undocumented - \since Haiku R1 */ @@ -108,9 +105,6 @@ \param tx Undocumented \param ty Undocumented - \return Undocumented - \retval Undocumented - \since Haiku R1 */ @@ -121,9 +115,6 @@ \param copyFrom Undocumented - \return Undocumented - \retval Undocumented - \since Haiku R1 */ @@ -132,9 +123,6 @@ \fn virtual virtual BAffineTransform::~BAffineTransform() \brief Undocumented public method - \return Undocumented - \retval Undocumented - \since Haiku R1 */ diff --git a/docs/user/interface/Alignment.dox b/docs/user/interface/Alignment.dox index debd7cb911..704507c6db 100644 --- a/docs/user/interface/Alignment.dox +++ b/docs/user/interface/Alignment.dox @@ -50,9 +50,6 @@ \fn BAlignment::BAlignment() \brief Undocumented public method - \return Undocumented - \retval Undocumented - \since Haiku R1 */ @@ -63,9 +60,6 @@ \param other Undocumented - \return Undocumented - \retval Undocumented - \since Haiku R1 */ @@ -77,9 +71,6 @@ \param horizontal Undocumented \param vertical Undocumented - \return Undocumented - \retval Undocumented - \since Haiku R1 */ diff --git a/docs/user/interface/ChannelControl.dox b/docs/user/interface/ChannelControl.dox index 909f403059..b04a16eee8 100644 --- a/docs/user/interface/ChannelControl.dox +++ b/docs/user/interface/ChannelControl.dox @@ -44,9 +44,6 @@ \param resizingMode Undocumented \param flags Undocumented - \return Undocumented - \retval Undocumented - \since Haiku R1 */ @@ -61,9 +58,6 @@ \param channelCount Undocumented \param flags Undocumented - \return Undocumented - \retval Undocumented - \since Haiku R1 */ @@ -74,9 +68,6 @@ \param archive Undocumented - \return Undocumented - \retval Undocumented - \since Haiku R1 */ @@ -85,9 +76,6 @@ \fn virtual virtual BChannelControl::~BChannelControl() \brief Undocumented public method - \return Undocumented - \retval Undocumented - \since Haiku R1 */ diff --git a/docs/user/interface/ChannelSlider.dox b/docs/user/interface/ChannelSlider.dox index 24677348d5..585f0ff6b0 100644 --- a/docs/user/interface/ChannelSlider.dox +++ b/docs/user/interface/ChannelSlider.dox @@ -42,9 +42,6 @@ \param resizeMode Undocumented \param flags Undocumented - \return Undocumented - \retval Undocumented - \since Haiku R1 */ @@ -62,9 +59,6 @@ \param resizeMode Undocumented \param flags Undocumented - \return Undocumented - \retval Undocumented - \since Haiku R1 */ @@ -80,9 +74,6 @@ \param channels Undocumented \param flags Undocumented - \return Undocumented - \retval Undocumented - \since Haiku R1 */ @@ -93,9 +84,6 @@ \param archive Undocumented - \return Undocumented - \retval Undocumented - \since Haiku R1 */ @@ -104,9 +92,6 @@ \fn virtual virtual BChannelSlider::~BChannelSlider() \brief Undocumented public method - \return Undocumented - \retval Undocumented - \since Haiku R1 */ diff --git a/docs/user/interface/Deskbar.dox b/docs/user/interface/Deskbar.dox index 77cf40d491..a8aaf229d9 100644 --- a/docs/user/interface/Deskbar.dox +++ b/docs/user/interface/Deskbar.dox @@ -34,9 +34,6 @@ \fn BDeskbar::BDeskbar() \brief Undocumented public method - \return Undocumented - \retval Undocumented - \since Haiku R1 */ @@ -45,9 +42,6 @@ \fn BDeskbar::~BDeskbar() \brief Undocumented public method - \return Undocumented - \retval Undocumented - \since Haiku R1 */ diff --git a/docs/user/interface/Input.dox b/docs/user/interface/Input.dox index 9cc5e06839..22c30a0308 100644 --- a/docs/user/interface/Input.dox +++ b/docs/user/interface/Input.dox @@ -39,9 +39,6 @@ \fn BInputDevice::~BInputDevice() \brief Undocumented public method - \return Undocumented - \retval Undocumented - \since Haiku R1 */ @@ -158,7 +155,7 @@ /*! \enum input_method_op - \ingroup + \ingroup interface \brief Undocumented enum. \since Haiku R1 diff --git a/docs/user/interface/OptionControl.dox b/docs/user/interface/OptionControl.dox index f4e7e16d36..8cccc4dff9 100644 --- a/docs/user/interface/OptionControl.dox +++ b/docs/user/interface/OptionControl.dox @@ -44,9 +44,6 @@ \param resizeMask Undocumented \param flags Undocumented - \return Undocumented - \retval Undocumented - \since Haiku R1 */ @@ -60,9 +57,6 @@ \param message Undocumented \param flags Undocumented - \return Undocumented - \retval Undocumented - \since Haiku R1 */ @@ -71,9 +65,6 @@ \fn virtual virtual BOptionControl::~BOptionControl() \brief Undocumented public method - \return Undocumented - \retval Undocumented - \since Haiku R1 */ diff --git a/docs/user/interface/SeparatorView.dox b/docs/user/interface/SeparatorView.dox index 27ac783c64..a6fb544bd6 100644 --- a/docs/user/interface/SeparatorView.dox +++ b/docs/user/interface/SeparatorView.dox @@ -37,9 +37,6 @@ \param orientation Undocumented \param border Undocumented - \return Undocumented - \retval Undocumented - \since Haiku R1 */ @@ -54,9 +51,6 @@ \param border Undocumented \param alignment Undocumented - \return Undocumented - \retval Undocumented - \since Haiku R1 */ @@ -71,9 +65,6 @@ \param border Undocumented \param alignment Undocumented - \return Undocumented - \retval Undocumented - \since Haiku R1 */ @@ -87,9 +78,6 @@ \param border Undocumented \param alignment Undocumented - \return Undocumented - \retval Undocumented - \since Haiku R1 */ @@ -103,9 +91,6 @@ \param border Undocumented \param alignment Undocumented - \return Undocumented - \retval Undocumented - \since Haiku R1 */ @@ -116,9 +101,6 @@ \param archive Undocumented - \return Undocumented - \retval Undocumented - \since Haiku R1 */ @@ -127,9 +109,6 @@ \fn virtual virtual BSeparatorView::~BSeparatorView() \brief Undocumented public method - \return Undocumented - \retval Undocumented - \since Haiku R1 */ diff --git a/docs/user/interface/StatusBar.dox b/docs/user/interface/StatusBar.dox index 7a6df80994..6ce2d5ff72 100644 --- a/docs/user/interface/StatusBar.dox +++ b/docs/user/interface/StatusBar.dox @@ -39,9 +39,6 @@ \param label Undocumented \param trailingLabel Undocumented - \return Undocumented - \retval Undocumented - \since Haiku R1 */ @@ -54,9 +51,6 @@ \param label Undocumented \param trailingLabel Undocumented - \return Undocumented - \retval Undocumented - \since Haiku R1 */ @@ -67,9 +61,6 @@ \param archive Undocumented - \return Undocumented - \retval Undocumented - \since Haiku R1 */ @@ -78,9 +69,6 @@ \fn virtual virtual BStatusBar::~BStatusBar() \brief Undocumented public method - \return Undocumented - \retval Undocumented - \since Haiku R1 */ diff --git a/docs/user/interface/Window.dox b/docs/user/interface/Window.dox index bcafa4a512..6dbbec493f 100644 --- a/docs/user/interface/Window.dox +++ b/docs/user/interface/Window.dox @@ -1298,24 +1298,6 @@ //! @{ -/*! - \fn void BWindow::AddShortcut(uint32 key, uint32 modifiers, BMenuItem* item) - \brief Creates a keyboard shortcut that activates a menu \a item. - - \param key The character that activates the shortcut, case-insensitive. - \param modifiers A bit mask of modifiers in addition to \c B_COMMAND_KEY, - options include: - - \c B_SHIFT_KEY - - \c B_OPTION_KEY - - \c B_CONTROL_KEY - - \c B_MENU_KEY - To remove \c B_COMMAND_KEY specify \c B_NO_COMMAND_KEY. - \param item The menu \a item to activate. - - \since Haiku R1 -*/ - - /*! \fn void BWindow::AddShortcut(uint32 key, uint32 modifiers, BMessage* message) \brief Creates a keyboard shortcut that sends a \a message to the window. diff --git a/docs/user/locale/UnicodeChar.dox b/docs/user/locale/UnicodeChar.dox index 1bcb034cfe..5ebf273e06 100644 --- a/docs/user/locale/UnicodeChar.dox +++ b/docs/user/locale/UnicodeChar.dox @@ -278,7 +278,7 @@ \fn void BUnicodeChar::ToUTF8(uint32 c, char** out) \brief Transform a character to UTF-8 encoding. - \returns The UTF-8 encoding of the specified unicode character. + \param[out] out Set to the UTF-8 encoding of the specified unicode character. \since Haiku R1 */ diff --git a/docs/user/posix/_libroot.dox b/docs/user/posix/_libroot.dox index 41f9227b75..61fbc3e8db 100644 --- a/docs/user/posix/_libroot.dox +++ b/docs/user/posix/_libroot.dox @@ -8,6 +8,7 @@ /*! \defgroup libroot C, POSIX, GNU and BSD functions +\brief Implements the C and POSIX standard libraries. Haiku implements a standard library containing the standard functions from C (https://www.iso.org/standard/29237.html) and POSIX diff --git a/docs/user/shared/_libshared.dox b/docs/user/shared/_libshared.dox new file mode 100644 index 0000000000..84429b6e64 --- /dev/null +++ b/docs/user/shared/_libshared.dox @@ -0,0 +1,30 @@ +/* + * Copyright 2025 Haiku, Inc. All rights reserved. + * Distributed under the terms of the MIT License. + * + * Authors: + * Adrien Destugues, pulkomandy@pulkomandy.tk + */ + +/*! +\defgroup libshared Experimental functions and classes +\brief Static library for experimental and work-in progress code. + +The main Haiku libraries (libroot, libbe and others) are provided as shared libraries. +This means in most cases, the ABI and API of functions and classes defined therein cannot be +changed without breaking existing applications that use them. + +This makes it difficult to expose work-in-progress code in these libraries, as any change of +interface would require all applications using the old interface to be recompiled. + +libshared provides a solution for that. It is provided as a static library, which means +applications using it will embed a fixed version of the libsared code that they were compiled +against. This way, updates to the library do not affect already compiled binaries, and developers +can update to a new version of libshared (and make any needed changes) when they recompile their +code. + +All functions and classes in libshared are additionally put in the BPrivate namespace. When an +API is deemed mature, its final version can be moved to a shared library, and at the same time, +moved out of the namespace. This makes sure applications that are still using a version from +libshared do not get interferenced by the newly introduced public version. +*/ diff --git a/docs/user/storage/_libtracker.dox b/docs/user/storage/_libtracker.dox new file mode 100644 index 0000000000..5ecce12397 --- /dev/null +++ b/docs/user/storage/_libtracker.dox @@ -0,0 +1,15 @@ +/* + * Copyright 2025 Haiku, Inc. All rights reserved. + * Distributed under the terms of the MIT License. + * + * Authors: + * Adrien Destugues, pulkomandy@pulkomandy.tk + */ + +/*! +\defgroup libtracker Tracker Kit +\brief Tracker components for use in other applications. + +This kit provides user interface and filesystem classes that are part of the Tracker file manager, +but are useful to other applications as well. +*/ diff --git a/docs/user/storage/storageintro.dox b/docs/user/storage/storageintro.dox index e02c1acd01..12c12ddc4f 100644 --- a/docs/user/storage/storageintro.dox +++ b/docs/user/storage/storageintro.dox @@ -32,7 +32,7 @@ filesystem hierarchy is available for non packaged software. This can be used to locally that is not available yet in HPKG form (for example, as a destination for "make install"). For a complete list of directories and how to access them in a way that is safe to future -filesystem reorganizations, see \link find_directory, \link find_path, and \link BPathFinder. +filesystem reorganizations, see \ref find_directory, \ref find_path, and \ref BPathFinder. */ diff --git a/docs/user/support/BufferedDataIO.dox b/docs/user/support/BufferedDataIO.dox index ad8b73ad65..35d5bb48f9 100644 --- a/docs/user/support/BufferedDataIO.dox +++ b/docs/user/support/BufferedDataIO.dox @@ -42,9 +42,6 @@ \param ownsStream Undocumented \param partialReads Undocumented - \return Undocumented - \retval Undocumented - \since Haiku R1 */ @@ -53,9 +50,6 @@ \fn virtual virtual BBufferedDataIO::~BBufferedDataIO() \brief Undocumented public method - \return Undocumented - \retval Undocumented - \since Haiku R1 */ diff --git a/docs/user/support/ObjectList.dox b/docs/user/support/ObjectList.dox index 871136f88f..7bfe4e378f 100644 --- a/docs/user/support/ObjectList.dox +++ b/docs/user/support/ObjectList.dox @@ -30,12 +30,11 @@ /*! - \fn template BObjectList::BObjectList(int32 itemsPerBlock, - bool owning) + \fn template BObjectList::BObjectList(int32 itemsPerBlock) \brief Creates a new BObjectList. \param itemsPerBlock The number of items per block to allocate. - \param owning Whether or not the BObjectList deletes its items when + \tparam owning Whether or not the BObjectList deletes its items when it is emptied or deleted. \since Haiku R1 @@ -43,8 +42,8 @@ /*! - \fn template BObjectList::BObjectList( - const BObjectList& list) + \fn template BObjectList::BObjectList( + const BObjectList& list) \brief Creates a new BObjectList as a copy of another \a list. \param list The \a list to copy from. @@ -54,7 +53,7 @@ /*! - \fn template BObjectList::~BObjectList() + \fn template BObjectList::~BObjectList() \brief Deletes the list. If the list owns its items they are deleted too. @@ -72,7 +71,7 @@ /*! - \fn template BObjectList& BObjectList::operator=( + \fn template BObjectList& BObjectList::operator=( const BObjectList& list) \brief Creates a new BObjectList as a copy of another \a list by overloading the = operator. @@ -126,7 +125,7 @@ /*! - \fn template bool BObjectList::AddList(BObjectList* list) + \fn template bool BObjectList::AddList(BObjectList* list) \brief Append a \a list of items to this list. The original list is not altered. @@ -142,7 +141,7 @@ /*! - \fn template bool BObjectList::AddList(BObjectList* list, + \fn template bool BObjectList::AddList(BObjectList* list, int32 index) \brief Add a \a list of items to this list at the specified \a index. diff --git a/docs/user/support/StackOrHeapArray.dox b/docs/user/support/StackOrHeapArray.dox index 7465b97bf3..de8ed3c8c0 100644 Binary files a/docs/user/support/StackOrHeapArray.dox and b/docs/user/support/StackOrHeapArray.dox differ diff --git a/docs/user/support/StringList.dox b/docs/user/support/StringList.dox index 1916d6de1d..8fb57805d4 100644 --- a/docs/user/support/StringList.dox +++ b/docs/user/support/StringList.dox @@ -36,9 +36,6 @@ \param count Undocumented - \return Undocumented - \retval Undocumented - \since Haiku R1 */ @@ -49,9 +46,6 @@ \param other Undocumented - \return Undocumented - \retval Undocumented - \since Haiku R1 */ @@ -60,9 +54,6 @@ \fn virtual virtual BStringList::~BStringList() \brief Undocumented public method - \return Undocumented - \retval Undocumented - \since Haiku R1 */ diff --git a/docs/user/support/Url.dox b/docs/user/support/Url.dox index ebe797b3ff..45d6f07e43 100644 --- a/docs/user/support/Url.dox +++ b/docs/user/support/Url.dox @@ -574,35 +574,6 @@ */ -/*! - \fn static static BString BUrl::UrlEncode(const BString &url, bool strict=false, bool directory=false) - \brief Undocumented public method - - \param url Undocumented - \param strict Undocumented - \param directory Undocumented - - \return Undocumented - \retval Undocumented - - \since Haiku R1 -*/ - - -/*! - \fn static static BString BUrl::UrlDecode(const BString &url, bool strict=false) - \brief Undocumented public method - - \param url Undocumented - \param strict Undocumented - - \return Undocumented - \retval Undocumented - - \since Haiku R1 -*/ - - /*! \fn static static BArchivable* BUrl::Instantiate(BMessage *archive) \brief Undocumented public method