hrev54631 adds 6 changesets to branch 'master'
old head: 5646b997786c9d11b9e1fda98b855bef6320da54
new head: 1e22d0d338bebf75b9ed8f69cd99fe3554d86fda
overview:
https://git.haiku-os.org/haiku/log/?qt=range&q=1e22d0d338be+%5E5646b997786c
----------------------------------------------------------------------------
ae78fb306254: HaikuBook: Add Makefile that supports the default and the develop
configurations
I use the develop configuration to generate a warnings file, which is useful
to
find undocumented members. The default configuration hides the undocumented
members and does not warn about them.
Change-Id: I09248c95bd51ea21118ff4f7ce57427d033981d2
Reviewed-on: https://review.haiku-os.org/c/haiku/+/3304
Reviewed-by: waddlesplash <waddlesplash@xxxxxxxxx>
42dcaf375d0d: 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@xxxxxxxxx>
85b475f07b34: HaikuBook: Add missing protected methods to BControl
Change-Id: Ia230272efa66bff96f9cd34ec910f4d1315fd1aa
Reviewed-on: https://review.haiku-os.org/c/haiku/+/3306
Reviewed-by: waddlesplash <waddlesplash@xxxxxxxxx>
2cb5a2c39463: HaikuBook: Add skeleton for support/DateTime.h and support/Job.h.
These are marked internal for now.
Change-Id: I09859060021e4b35c355c9a0400da6f8bc6653e2
Reviewed-on: https://review.haiku-os.org/c/haiku/+/3307
Reviewed-by: waddlesplash <waddlesplash@xxxxxxxxx>
5a6d68bbfa79: HaikuBook: add instructions for including INTERNAL documentation
Change-Id: Ifb539a0a11d6aa9f496aa493d7a47a08016818be
Reviewed-on: https://review.haiku-os.org/c/haiku/+/3308
Reviewed-by: waddlesplash <waddlesplash@xxxxxxxxx>
1e22d0d338be: HaikuBook: Improvements to the GraphicsDefs.h documentations
Still lots more to do, but it is a start.
Change-Id: Ia83e7f4b751a860b3005d34841b58f31450613ce
Reviewed-on: https://review.haiku-os.org/c/haiku/+/3309
Reviewed-by: waddlesplash <waddlesplash@xxxxxxxxx>
[ Niels Sascha Reedijk <niels.reedijk@xxxxxxxxx> ]
----------------------------------------------------------------------------
9 files changed, 2398 insertions(+), 11 deletions(-)
docs/user/Doxyfile | 4 +-
docs/user/Makefile | 12 +
docs/user/apidoc.dox | 25 +-
docs/user/app/LaunchRoster.dox | 157 +++-
docs/user/interface/Control.dox | 74 +-
docs/user/interface/GraphicsDefs.dox | 299 ++++++-
docs/user/interface/ToolTip.dox | 125 +++
docs/user/support/DateTime.dox | 1328 ++++++++++++++++++++++++++++++
docs/user/support/Job.dox | 385 +++++++++
############################################################################
Commit: ae78fb306254df55e5e75297a7914edca7b3a26f
URL: https://git.haiku-os.org/haiku/commit/?id=ae78fb306254
Author: Niels Sascha Reedijk <niels.reedijk@xxxxxxxxx>
Date: Thu Oct 8 09:25:08 2020 UTC
Committer: waddlesplash <waddlesplash@xxxxxxxxx>
Commit-Date: Sun Oct 11 15:46:06 2020 UTC
HaikuBook: Add Makefile that supports the default and the develop configurations
I use the develop configuration to generate a warnings file, which is useful to
find undocumented members. The default configuration hides the undocumented
members and does not warn about them.
Change-Id: I09248c95bd51ea21118ff4f7ce57427d033981d2
Reviewed-on: https://review.haiku-os.org/c/haiku/+/3304
Reviewed-by: waddlesplash <waddlesplash@xxxxxxxxx>
----------------------------------------------------------------------------
diff --git a/docs/user/Makefile b/docs/user/Makefile
new file mode 100644
index 0000000000..fead8c200e
--- /dev/null
+++ b/docs/user/Makefile
@@ -0,0 +1,12 @@
+define DEVELOP_CONFIG
+HIDE_UNDOC_MEMBERS = NO
+HIDE_UNDOC_CLASSES = NO
+ENABLED_SECTIONS = INTERNAL
+WARN_LOGFILE = "../../generated/doxygen/warnings.txt"
+GENERATE_XML = YES
+endef
+export DEVELOP_CONFIG
+default:
+ doxygen
+develop:
+ (cat Doxyfile; echo "$$DEVELOP_CONFIG") | doxygen -
\ No newline at end of file
############################################################################
Commit: 42dcaf375d0dec72d4c016a1be9e02905d9c0d68
URL: https://git.haiku-os.org/haiku/commit/?id=42dcaf375d0d
Author: Niels Sascha Reedijk <niels.reedijk@xxxxxxxxx>
Date: Thu Oct 8 09:33:38 2020 UTC
Committer: waddlesplash <waddlesplash@xxxxxxxxx>
Commit-Date: Sun Oct 11 15:46:06 2020 UTC
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@xxxxxxxxx>
----------------------------------------------------------------------------
diff --git a/docs/user/Doxyfile b/docs/user/Doxyfile
index 01fd9b8897..7d5c86c00b 100644
--- a/docs/user/Doxyfile
+++ b/docs/user/Doxyfile
@@ -838,14 +838,14 @@ INPUT = . \
support \
translation \
../../headers/os/app \
- ../../headers/private/app \
+ ../../headers/private/app/LaunchRoster.h \
../../headers/os/device/Joystick.h \
../../headers/os/drivers/fs_interface.h \
../../headers/os/drivers/USB3.h \
../../headers/os/drivers/USB_spec.h \
../../headers/os/game \
../../headers/os/interface \
- ../../headers/private/interface \
+ ../../headers/private/interface/ToolTip.h \
../../headers/os/locale \
../../headers/os/mail \
../../headers/os/media \
diff --git a/docs/user/app/LaunchRoster.dox b/docs/user/app/LaunchRoster.dox
index 16bdac5508..3a9e699671 100644
--- a/docs/user/app/LaunchRoster.dox
+++ b/docs/user/app/LaunchRoster.dox
@@ -11,6 +11,9 @@
*/
+//! \cond INTERNAL
+
+
/*!
\file LaunchRoster.h
\ingroup app
@@ -29,7 +32,7 @@
\link launch_intro Introduction to the Launch Daemon \endlink.
\warning This class is not yet finalized, if you use it in your software
- assume that it will break some time in the future.
+ assume that it will break some time in the future.
\since Haiku R1
*/
@@ -85,7 +88,7 @@
if any.
\param signature The app \a signature.
- \param data BMessage object to store the launch data in.
+ \param data BMessage object to store the launch data in.
\return \c B_OK if the launch data has been received successfully.
\since Haiku R1
@@ -284,3 +287,153 @@ on {
//! @}
+
+
+/*!
+ \fn status_t BLaunchRoster::GetJobInfo(const char *name, BMessage &info)
+ \brief Undocumented public method
+
+ \param name Undocumented
+ \param info Undocumented
+
+ \return Undocumented
+ \retval <value> Undocumented
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \fn status_t BLaunchRoster::GetJobs(const char *target, BStringList
&jobs)
+ \brief Undocumented public method
+
+ \param target Undocumented
+ \param jobs Undocumented
+
+ \return Undocumented
+ \retval <value> Undocumented
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \fn status_t BLaunchRoster::GetLog(BMessage &info)
+ \brief Undocumented public method
+
+ \param info Undocumented
+
+ \return Undocumented
+ \retval <value> Undocumented
+ \since Haiku R1
+*/
+
+
+/*!
+ \fn status_t BLaunchRoster::GetLog(const BMessage &filter, BMessage
&info)
+ \brief Undocumented public method
+
+ \param filter Undocumented
+ \param info Undocumented
+
+ \return Undocumented
+ \retval <value> Undocumented
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \fn status_t BLaunchRoster::GetTargetInfo(const char *name, BMessage
&info)
+ \brief Undocumented public method
+
+ \param name Undocumented
+ \param info Undocumented
+
+ \return Undocumented
+ \retval <value> Undocumented
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \fn status_t BLaunchRoster::GetTargets(BStringList &targets)
+ \brief Undocumented public method
+
+ \param targets Undocumented
+
+ \return Undocumented
+ \retval <value> Undocumented
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \fn status_t BLaunchRoster::InitCheck() const
+ \brief Undocumented public method
+
+ \return Undocumented
+ \retval <value> Undocumented
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \fn status_t BLaunchRoster::SetEnabled(const char *name, bool enabled)
+ \brief Undocumented public method
+
+ \param name Undocumented
+ \param enabled Undocumented
+
+ \return Undocumented
+ \retval <value> Undocumented
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \fn status_t BLaunchRoster::Start(const char *name)
+ \brief Undocumented public method
+
+ \param name Undocumented
+
+ \return Undocumented
+ \retval <value> Undocumented
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \fn status_t BLaunchRoster::Stop(const char *name, bool force=false)
+ \brief Undocumented public method
+
+ \param name Undocumented
+ \param force Undocumented
+
+ \return Undocumented
+ \retval <value> Undocumented
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \fn status_t BLaunchRoster::StopTarget(const char *name, bool
force=false)
+ \brief Undocumented public method
+
+ \param name Undocumented
+ \param force Undocumented
+
+ \return Undocumented
+ \retval <value> Undocumented
+
+ \since Haiku R1
+*/
+
+
+//! \endcond INTERNAL
diff --git a/docs/user/interface/ToolTip.dox b/docs/user/interface/ToolTip.dox
index e64f54b4e9..e1dc9c3b58 100644
--- a/docs/user/interface/ToolTip.dox
+++ b/docs/user/interface/ToolTip.dox
@@ -13,6 +13,9 @@
*/
+//! \cond INTERNAL
+
+
/*!
\file ToolTip.h
\ingroup interface
@@ -149,3 +152,125 @@
\since Haiku R1
*/
+
+
+/*!
+ \fn virtual void BToolTip::AttachedToWindow()
+ \brief Undocumented public method
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \fn virtual void BToolTip::DetachedFromWindow()
+ \brief Undocumented public method
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \fn virtual BView* BToolTip::View() const =0
+ \brief Undocumented public method
+
+ \return Undocumented
+ \retval <value> Undocumented
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \class BTextToolTip
+ \ingroup interface
+ \ingroup libbe
+ \brief Undocumented class.
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \fn BTextToolTip::BTextToolTip(BMessage *archive)
+ \brief Undocumented public method
+
+ \param archive Undocumented
+
+ \return Undocumented
+ \retval <value> Undocumented
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \fn BTextToolTip::BTextToolTip(const char *text)
+ \brief Undocumented public method
+
+ \param text Undocumented
+
+ \return Undocumented
+ \retval <value> Undocumented
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \fn virtual BTextToolTip::~BTextToolTip()
+ \brief Undocumented public method
+
+ \return Undocumented
+ \retval <value> Undocumented
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \fn void BTextToolTip::SetText(const char *text)
+ \brief Undocumented public method
+
+ \param text Undocumented
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \fn const char* BTextToolTip::Text() const
+ \brief Undocumented public method
+
+ \return Undocumented
+ \retval <value> Undocumented
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \fn virtual BView* BTextToolTip::View() const
+ \brief Undocumented public method
+
+ \return Undocumented
+ \retval <value> Undocumented
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \fn static BTextToolTip* BTextToolTip::Instantiate(BMessage *archive)
+ \brief Undocumented public method
+
+ \param archive Undocumented
+
+ \return Undocumented
+ \retval <value> Undocumented
+
+ \since Haiku R1
+*/
+
+
+//! \endcond INTERNAL
############################################################################
Commit: 85b475f07b34547162e76d2ee814c2e904e5b9e6
URL: https://git.haiku-os.org/haiku/commit/?id=85b475f07b34
Author: Niels Sascha Reedijk <niels.reedijk@xxxxxxxxx>
Date: Thu Oct 8 12:41:31 2020 UTC
Committer: waddlesplash <waddlesplash@xxxxxxxxx>
Commit-Date: Sun Oct 11 15:46:06 2020 UTC
HaikuBook: Add missing protected methods to BControl
Change-Id: Ia230272efa66bff96f9cd34ec910f4d1315fd1aa
Reviewed-on: https://review.haiku-os.org/c/haiku/+/3306
Reviewed-by: waddlesplash <waddlesplash@xxxxxxxxx>
----------------------------------------------------------------------------
diff --git a/docs/user/interface/Control.dox b/docs/user/interface/Control.dox
index a5f6c9a085..c21b35995f 100644
--- a/docs/user/interface/Control.dox
+++ b/docs/user/interface/Control.dox
@@ -1,13 +1,13 @@
/*
- * Copyright 2011-2014 Haiku, Inc. All rights reserved.
+ * Copyright 2011-2014, 2020 Haiku, Inc. All rights reserved.
* Distributed under the terms of the MIT License.
*
* Authors:
* John Scipione, jscipione@xxxxxxxxx
*
* Corresponds to:
- * headers/os/interface/Control.h hrev47274
- * src/kits/interface/Control.cpp hrev47274
+ * headers/os/interface/Control.h hrev47369
+ * src/kits/interface/Control.cpp hrev51550
*/
@@ -510,3 +510,71 @@
\since Haiku R1
*/
+
+
+/*!
+ \fn const BBitmap* BControl::IconBitmap(uint32 which) const
+ \brief Get the currently set bitmap for a specific state.
+
+ \param which The state to retrieve the icon for.
+
+ \return A pointer to the icon set for the state, or \c NULL in case
there
+ is no icon set for that state.
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \fn bool BControl::IsFocusChanging() const
+ \brief Check if the control is changing focus
+
+ Many controls have different looks depending on whether they have focus
or
+ not. You can use this method within your Draw() call to determine
whether
+ you are asked to redraw because the focus is changing, meaning your
control
+ is getting in or out of focus, so that you can conditionally run the
+ drawing code.
+
+ \retval true The Draw() method was called because of a focus change for
+ this control.
+ \retval false The Draw() method was not called because of a focus change
+ for this control.
+
+ \since BeOS R5
+*/
+
+
+/*!
+ \fn bool BControl::IsTracking() const
+ \brief Check whether this control is set to tracking
+
+ See SetTracking() for the usage pattern. By default, the control wil
return
+ \c false.
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \fn void BControl::SetTracking(bool state)
+ \brief Modify the control's tracking state
+
+ The tracking state is a feature of this BControl class, that allows you
to
+ set a flag when you are watching the behavior of users when they
interact
+ with your control.
+
+ For example, a button may have a draw state when it is not pressed, and
+ when it is pressed. When the user presses their mouse down, within the
+ control, the control will be drawn in the pressed state. The code can
set
+ the tracking flag, so that in the case of the mouse up event, the
control
+ knows it has to redraw.
+
+ This flag does not affect anything within this class, other than the
return
+ value of the \ref IsTracking() method, so it can be used at will by
custom
+ implementations of this class.
+
+ \param state Pass \c true if the control is in a tracking state, or
+ \c false if it is not.
+
+ \since Haiku R1
+*/
############################################################################
Commit: 2cb5a2c3946309aa07c9e4e9436a89d7050b2a5d
URL: https://git.haiku-os.org/haiku/commit/?id=2cb5a2c39463
Author: Niels Sascha Reedijk <niels.reedijk@xxxxxxxxx>
Date: Thu Oct 8 15:16:17 2020 UTC
Committer: waddlesplash <waddlesplash@xxxxxxxxx>
Commit-Date: Sun Oct 11 15:46:06 2020 UTC
HaikuBook: Add skeleton for support/DateTime.h and support/Job.h.
These are marked internal for now.
Change-Id: I09859060021e4b35c355c9a0400da6f8bc6653e2
Reviewed-on: https://review.haiku-os.org/c/haiku/+/3307
Reviewed-by: waddlesplash <waddlesplash@xxxxxxxxx>
----------------------------------------------------------------------------
diff --git a/docs/user/support/DateTime.dox b/docs/user/support/DateTime.dox
new file mode 100644
index 0000000000..32c54065cd
--- /dev/null
+++ b/docs/user/support/DateTime.dox
@@ -0,0 +1,1328 @@
+/*
+ * Copyright 2020 Haiku, Inc. All rights reserved.
+ * Distributed under the terms of the MIT License.
+ *
+ * Authors:
+ * Name, email@xxxxxxxxx
+ *
+ * Corresponds to:
+ * headers/os/<kitname>/<filename>.h hrev*****
+ * src/kits/<kitname>/<filename>.cpp hrev*****
+ */
+
+
+//! \cond INTERNAL
+
+
+/*!
+ \file DateTime.h
+ \ingroup support
+ \brief Undocumented file.
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \enum BPrivate::time_type
+ \brief Undocumented enum
+*/
+
+
+/*!
+ \var time_type BPrivate::B_GMT_TIME
+ \brief Undocumented
+*/
+
+
+/*!
+ \var time_type BPrivate::B_LOCAL_TIME
+ \brief Undocumented
+*/
+
+
+/*!
+ \enum BPrivate::diff_type
+ \brief Undocumented enum
+*/
+
+
+/*!
+ \var diff_time BPrivate::B_HOURS_DIFF
+ \brief Undocumented
+*/
+
+
+/*!
+ \var diff_time BPrivate::B_MINUTES_DIFF
+ \brief Undocumented
+*/
+
+
+/*!
+ \var diff_time BPrivate::B_SECONDS_DIFF
+ \brief Undocumented
+*/
+
+
+/*!
+ \var diff_time BPrivate::B_MILLISECONDS_DIFF
+ \brief Undocumented
+*/
+
+
+/*!
+ \var diff_time BPrivate::B_MICROSECONDS_DIFF
+ \brief Undocumented
+*/
+
+
+/*!
+ \class BPrivate::BTime
+ \ingroup support
+ \ingroup libbe
+ \brief Undocumented class.
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \fn BPrivate::BTime::BTime()
+ \brief Undocumented public method
+
+ \return Undocumented
+ \retval <value> Undocumented
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \fn BPrivate::BTime::BTime(const BMessage *archive)
+ \brief Undocumented public method
+
+ \param archive Undocumented
+
+ \return Undocumented
+ \retval <value> Undocumented
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \fn BPrivate::BTime::BTime(const BTime &other)
+ \brief Undocumented public method
+
+ \param other Undocumented
+
+ \return Undocumented
+ \retval <value> Undocumented
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \fn BPrivate::BTime::BTime(int32 hour, int32 minute, int32 second,
int32 microsecond=0)
+ \brief Undocumented public method
+
+ \param hour Undocumented
+ \param minute Undocumented
+ \param second Undocumented
+ \param microsecond Undocumented
+
+ \return Undocumented
+ \retval <value> Undocumented
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \fn BPrivate::BTime::~BTime()
+ \brief Undocumented public method
+
+ \return Undocumented
+ \retval <value> Undocumented
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \fn BTime& BPrivate::BTime::AddHours(int32 hours)
+ \brief Undocumented public method
+
+ \param hours Undocumented
+
+ \return Undocumented
+ \retval <value> Undocumented
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \fn BTime& BPrivate::BTime::AddMicroseconds(int32 microseconds)
+ \brief Undocumented public method
+
+ \param microseconds Undocumented
+
+ \return Undocumented
+ \retval <value> Undocumented
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \fn BTime& BPrivate::BTime::AddMilliseconds(int32 milliseconds)
+ \brief Undocumented public method
+
+ \param milliseconds Undocumented
+
+ \return Undocumented
+ \retval <value> Undocumented
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \fn BTime& BPrivate::BTime::AddMinutes(int32 minutes)
+ \brief Undocumented public method
+
+ \param minutes Undocumented
+
+ \return Undocumented
+ \retval <value> Undocumented
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \fn BTime& BPrivate::BTime::AddSeconds(int32 seconds)
+ \brief Undocumented public method
+
+ \param seconds Undocumented
+
+ \return Undocumented
+ \retval <value> Undocumented
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \fn status_t BPrivate::BTime::Archive(BMessage *into) const
+ \brief Undocumented public method
+
+ \param into Undocumented
+
+ \return Undocumented
+ \retval <value> Undocumented
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \fn bigtime_t BPrivate::BTime::Difference(const BTime &time, diff_type
type) const
+ \brief Undocumented public method
+
+ \param time Undocumented
+ \param type Undocumented
+
+ \return Undocumented
+ \retval <value> Undocumented
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \fn int32 BPrivate::BTime::Hour() const
+ \brief Undocumented public method
+
+ \return Undocumented
+ \retval <value> Undocumented
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \fn bool BPrivate::BTime::IsValid() const
+ \brief Undocumented public method
+
+ \return Undocumented
+ \retval <value> Undocumented
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \fn int32 BPrivate::BTime::Microsecond() const
+ \brief Undocumented public method
+
+ \return Undocumented
+ \retval <value> Undocumented
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \fn int32 BPrivate::BTime::Millisecond() const
+ \brief Undocumented public method
+
+ \return Undocumented
+ \retval <value> Undocumented
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \fn int32 BPrivate::BTime::Minute() const
+ \brief Undocumented public method
+
+ \return Undocumented
+ \retval <value> Undocumented
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \fn bool BPrivate::BTime::operator!=(const BTime &time) const
+ \brief Undocumented public method
+
+ \param time Undocumented
+
+ \return Undocumented
+ \retval <value> Undocumented
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \fn bool BPrivate::BTime::operator<(const BTime &time) const
+ \brief Undocumented public method
+
+ \param time Undocumented
+
+ \return Undocumented
+ \retval <value> Undocumented
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \fn bool BPrivate::BTime::operator<=(const BTime &time) const
+ \brief Undocumented public method
+
+ \param time Undocumented
+
+ \return Undocumented
+ \retval <value> Undocumented
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \fn bool BPrivate::BTime::operator==(const BTime &time) const
+ \brief Undocumented public method
+
+ \param time Undocumented
+
+ \return Undocumented
+ \retval <value> Undocumented
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \fn bool BPrivate::BTime::operator>(const BTime &time) const
+ \brief Undocumented public method
+
+ \param time Undocumented
+
+ \return Undocumented
+ \retval <value> Undocumented
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \fn bool BPrivate::BTime::operator>=(const BTime &time) const
+ \brief Undocumented public method
+
+ \param time Undocumented
+
+ \return Undocumented
+ \retval <value> Undocumented
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \fn int32 BPrivate::BTime::Second() const
+ \brief Undocumented public method
+
+ \return Undocumented
+ \retval <value> Undocumented
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \fn bool BPrivate::BTime::SetTime(const BTime &time)
+ \brief Undocumented public method
+
+ \param time Undocumented
+
+ \return Undocumented
+ \retval <value> Undocumented
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \fn bool BPrivate::BTime::SetTime(int32 hour, int32 minute, int32
second, int32 microsecond=0)
+ \brief Undocumented public method
+
+ \param hour Undocumented
+ \param minute Undocumented
+ \param second Undocumented
+ \param microsecond Undocumented
+
+ \return Undocumented
+ \retval <value> Undocumented
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \fn BTime BPrivate::BTime::Time() const
+ \brief Undocumented public method
+
+ \return Undocumented
+ \retval <value> Undocumented
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \fn static BTime BPrivate::BTime::CurrentTime(time_type type)
+ \brief Undocumented public method
+
+ \param type Undocumented
+
+ \return Undocumented
+ \retval <value> Undocumented
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \fn static bool BPrivate::BTime::IsValid(const BTime &time)
+ \brief Undocumented public method
+
+ \param time Undocumented
+
+ \return Undocumented
+ \retval <value> Undocumented
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \fn static bool BPrivate::BTime::IsValid(int32 hour, int32 minute,
int32 second, int32 microsecond=0)
+ \brief Undocumented public method
+
+ \param hour Undocumented
+ \param minute Undocumented
+ \param second Undocumented
+ \param microsecond Undocumented
+
+ \return Undocumented
+ \retval <value> Undocumented
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \class BPrivate::BDate
+ \ingroup support
+ \ingroup libbe
+ \brief Undocumented class.
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \fn BPrivate::BDate::BDate()
+ \brief Undocumented public method
+
+ \return Undocumented
+ \retval <value> Undocumented
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \fn BPrivate::BDate::BDate(const BDate &other)
+ \brief Undocumented public method
+
+ \param other Undocumented
+
+ \return Undocumented
+ \retval <value> Undocumented
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \fn BPrivate::BDate::BDate(const BMessage *archive)
+ \brief Undocumented public method
+
+ \param archive Undocumented
+
+ \return Undocumented
+ \retval <value> Undocumented
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \fn BPrivate::BDate::BDate(int32 year, int32 month, int32 day)
+ \brief Undocumented public method
+
+ \param year Undocumented
+ \param month Undocumented
+ \param day Undocumented
+
+ \return Undocumented
+ \retval <value> Undocumented
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \fn BPrivate::BDate::BDate(time_t time, time_type type=B_LOCAL_TIME)
+ \brief Undocumented public method
+
+ \param time Undocumented
+ \param type Undocumented
+
+ \return Undocumented
+ \retval <value> Undocumented
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \fn BPrivate::BDate::~BDate()
+ \brief Undocumented public method
+
+ \return Undocumented
+ \retval <value> Undocumented
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \fn void BPrivate::BDate::AddDays(int32 days)
+ \brief Undocumented public method
+
+ \param days Undocumented
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \fn void BPrivate::BDate::AddMonths(int32 months)
+ \brief Undocumented public method
+
+ \param months Undocumented
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \fn void BPrivate::BDate::AddYears(int32 years)
+ \brief Undocumented public method
+
+ \param years Undocumented
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \fn status_t BPrivate::BDate::Archive(BMessage *into) const
+ \brief Undocumented public method
+
+ \param into Undocumented
+
+ \return Undocumented
+ \retval <value> Undocumented
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \fn BDate BPrivate::BDate::Date() const
+ \brief Undocumented public method
+
+ \return Undocumented
+ \retval <value> Undocumented
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \fn int32 BPrivate::BDate::DateToJulianDay() const
+ \brief Undocumented public method
+
+ \return Undocumented
+ \retval <value> Undocumented
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \fn int32 BPrivate::BDate::Day() const
+ \brief Undocumented public method
+
+ \return Undocumented
+ \retval <value> Undocumented
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \fn int32 BPrivate::BDate::DayOfWeek() const
+ \brief Undocumented public method
+
+ \return Undocumented
+ \retval <value> Undocumented
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \fn int32 BPrivate::BDate::DayOfYear() const
+ \brief Undocumented public method
+
+ \return Undocumented
+ \retval <value> Undocumented
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \fn int32 BPrivate::BDate::DaysInMonth() const
+ \brief Undocumented public method
+
+ \return Undocumented
+ \retval <value> Undocumented
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \fn int32 BPrivate::BDate::DaysInYear() const
+ \brief Undocumented public method
+
+ \return Undocumented
+ \retval <value> Undocumented
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \fn int32 BPrivate::BDate::Difference(const BDate &date) const
+ \brief Undocumented public method
+
+ \param date Undocumented
+
+ \return Undocumented
+ \retval <value> Undocumented
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \fn void BPrivate::BDate::GetDate(int32 *year, int32 *month, int32
*day) const
+ \brief Undocumented public method
+
+ \param year Undocumented
+ \param month Undocumented
+ \param day Undocumented
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \fn bool BPrivate::BDate::IsLeapYear() const
+ \brief Undocumented public method
+
+ \return Undocumented
+ \retval <value> Undocumented
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \fn bool BPrivate::BDate::IsValid() const
+ \brief Undocumented public method
+
+ \return Undocumented
+ \retval <value> Undocumented
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \fn BString BPrivate::BDate::LongDayName() const
+ \brief Undocumented public method
+
+ \return Undocumented
+ \retval <value> Undocumented
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \fn BString BPrivate::BDate::LongMonthName() const
+ \brief Undocumented public method
+
+ \return Undocumented
+ \retval <value> Undocumented
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \fn int32 BPrivate::BDate::Month() const
+ \brief Undocumented public method
+
+ \return Undocumented
+ \retval <value> Undocumented
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \fn bool BPrivate::BDate::operator!=(const BDate &date) const
+ \brief Undocumented public method
+
+ \param date Undocumented
+
+ \return Undocumented
+ \retval <value> Undocumented
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \fn bool BPrivate::BDate::operator<(const BDate &date) const
+ \brief Undocumented public method
+
+ \param date Undocumented
+
+ \return Undocumented
+ \retval <value> Undocumented
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \fn bool BPrivate::BDate::operator<=(const BDate &date) const
+ \brief Undocumented public method
+
+ \param date Undocumented
+
+ \return Undocumented
+ \retval <value> Undocumented
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \fn bool BPrivate::BDate::operator==(const BDate &date) const
+ \brief Undocumented public method
+
+ \param date Undocumented
+
+ \return Undocumented
+ \retval <value> Undocumented
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \fn bool BPrivate::BDate::operator>(const BDate &date) const
+ \brief Undocumented public method
+
+ \param date Undocumented
+
+ \return Undocumented
+ \retval <value> Undocumented
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \fn bool BPrivate::BDate::operator>=(const BDate &date) const
+ \brief Undocumented public method
+
+ \param date Undocumented
+
+ \return Undocumented
+ \retval <value> Undocumented
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \fn bool BPrivate::BDate::SetDate(const BDate &date)
+ \brief Undocumented public method
+
+ \param date Undocumented
+
+ \return Undocumented
+ \retval <value> Undocumented
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \fn bool BPrivate::BDate::SetDate(int32 year, int32 month, int32 day)
+ \brief Undocumented public method
+
+ \param year Undocumented
+ \param month Undocumented
+ \param day Undocumented
+
+ \return Undocumented
+ \retval <value> Undocumented
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \fn void BPrivate::BDate::SetDay(int32 day)
+ \brief Undocumented public method
+
+ \param day Undocumented
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \fn void BPrivate::BDate::SetMonth(int32 month)
+ \brief Undocumented public method
+
+ \param month Undocumented
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \fn void BPrivate::BDate::SetYear(int32 year)
+ \brief Undocumented public method
+
+ \param year Undocumented
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \fn BString BPrivate::BDate::ShortDayName() const
+ \brief Undocumented public method
+
+ \return Undocumented
+ \retval <value> Undocumented
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \fn BString BPrivate::BDate::ShortMonthName() const
+ \brief Undocumented public method
+
+ \return Undocumented
+ \retval <value> Undocumented
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \fn int32 BPrivate::BDate::WeekNumber() const
+ \brief Undocumented public method
+
+ \return Undocumented
+ \retval <value> Undocumented
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \fn int32 BPrivate::BDate::Year() const
+ \brief Undocumented public method
+
+ \return Undocumented
+ \retval <value> Undocumented
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \fn static BDate BPrivate::BDate::CurrentDate(time_type type)
+ \brief Undocumented public method
+
+ \param type Undocumented
+
+ \return Undocumented
+ \retval <value> Undocumented
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \fn static bool BPrivate::BDate::IsLeapYear(int32 year)
+ \brief Undocumented public method
+
+ \param year Undocumented
+
+ \return Undocumented
+ \retval <value> Undocumented
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \fn static bool BPrivate::BDate::IsValid(const BDate &date)
+ \brief Undocumented public method
+
+ \param date Undocumented
+
+ \return Undocumented
+ \retval <value> Undocumented
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \fn static bool BPrivate::BDate::IsValid(int32 year, int32 month, int32
day)
+ \brief Undocumented public method
+
+ \param year Undocumented
+ \param month Undocumented
+ \param day Undocumented
+
+ \return Undocumented
+ \retval <value> Undocumented
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \fn static BDate BPrivate::BDate::JulianDayToDate(int32 julianDay)
+ \brief Undocumented public method
+
+ \param julianDay Undocumented
+
+ \return Undocumented
+ \retval <value> Undocumented
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \fn static BString BPrivate::BDate::LongDayName(int32 day)
+ \brief Undocumented public method
+
+ \param day Undocumented
+
+ \return Undocumented
+ \retval <value> Undocumented
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \fn static BString BPrivate::BDate::LongMonthName(int32 month)
+ \brief Undocumented public method
+
+ \param month Undocumented
+
+ \return Undocumented
+ \retval <value> Undocumented
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \fn static BString BPrivate::BDate::ShortDayName(int32 day)
+ \brief Undocumented public method
+
+ \param day Undocumented
+
+ \return Undocumented
+ \retval <value> Undocumented
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \fn static BString BPrivate::BDate::ShortMonthName(int32 month)
+ \brief Undocumented public method
+
+ \param month Undocumented
+
+ \return Undocumented
+ \retval <value> Undocumented
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \class BPrivate::BDateTime
+ \ingroup support
+ \ingroup libbe
+ \brief Undocumented class.
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \fn BPrivate::BDateTime::BDateTime()
+ \brief Undocumented public method
+
+ \return Undocumented
+ \retval <value> Undocumented
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \fn BPrivate::BDateTime::BDateTime(const BDate &date, const BTime &time)
+ \brief Undocumented public method
+
+ \param date Undocumented
+ \param time Undocumented
+
+ \return Undocumented
+ \retval <value> Undocumented
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \fn BPrivate::BDateTime::BDateTime(const BMessage *archive)
+ \brief Undocumented public method
+
+ \param archive Undocumented
+
+ \return Undocumented
+ \retval <value> Undocumented
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \fn BPrivate::BDateTime::~BDateTime()
+ \brief Undocumented public method
+
+ \return Undocumented
+ \retval <value> Undocumented
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \fn status_t BPrivate::BDateTime::Archive(BMessage *into) const
+ \brief Undocumented public method
+
+ \param into Undocumented
+
+ \return Undocumented
+ \retval <value> Undocumented
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \fn BDate& BPrivate::BDateTime::Date()
+ \brief Undocumented public method
+
+ \return Undocumented
+ \retval <value> Undocumented
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \fn const BDate& BPrivate::BDateTime::Date() const
+ \brief Undocumented public method
+
+ \return Undocumented
+ \retval <value> Undocumented
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \fn bool BPrivate::BDateTime::IsValid() const
+ \brief Undocumented public method
+
+ \return Undocumented
+ \retval <value> Undocumented
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \fn bool BPrivate::BDateTime::operator!=(const BDateTime &dateTime)
const
+ \brief Undocumented public method
+
+ \param dateTime Undocumented
+
+ \return Undocumented
+ \retval <value> Undocumented
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \fn bool BPrivate::BDateTime::operator<(const BDateTime &dateTime) const
+ \brief Undocumented public method
+
+ \param dateTime Undocumented
+
+ \return Undocumented
+ \retval <value> Undocumented
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \fn bool BPrivate::BDateTime::operator<=(const BDateTime &dateTime)
const
+ \brief Undocumented public method
+
+ \param dateTime Undocumented
+
+ \return Undocumented
+ \retval <value> Undocumented
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \fn bool BPrivate::BDateTime::operator==(const BDateTime &dateTime)
const
+ \brief Undocumented public method
+
+ \param dateTime Undocumented
+
+ \return Undocumented
+ \retval <value> Undocumented
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \fn bool BPrivate::BDateTime::operator>(const BDateTime &dateTime) const
+ \brief Undocumented public method
+
+ \param dateTime Undocumented
+
+ \return Undocumented
+ \retval <value> Undocumented
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \fn bool BPrivate::BDateTime::operator>=(const BDateTime &dateTime)
const
+ \brief Undocumented public method
+
+ \param dateTime Undocumented
+
+ \return Undocumented
+ \retval <value> Undocumented
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \fn void BPrivate::BDateTime::SetDate(const BDate &date)
+ \brief Undocumented public method
+
+ \param date Undocumented
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \fn void BPrivate::BDateTime::SetDateTime(const BDate &date, const
BTime &time)
+ \brief Undocumented public method
+
+ \param date Undocumented
+ \param time Undocumented
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \fn void BPrivate::BDateTime::SetTime(const BTime &time)
+ \brief Undocumented public method
+
+ \param time Undocumented
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \fn void BPrivate::BDateTime::SetTime_t(time_t seconds)
+ \brief Undocumented public method
+
+ \param seconds Undocumented
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \fn BTime& BPrivate::BDateTime::Time()
+ \brief Undocumented public method
+
+ \return Undocumented
+ \retval <value> Undocumented
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \fn const BTime& BPrivate::BDateTime::Time() const
+ \brief Undocumented public method
+
+ \return Undocumented
+ \retval <value> Undocumented
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \fn time_t BPrivate::BDateTime::Time_t() const
+ \brief Undocumented public method
+
+ \return Undocumented
+ \retval <value> Undocumented
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \fn static BDateTime BPrivate::BDateTime::CurrentDateTime(time_type
type)
+ \brief Undocumented public method
+
+ \param type Undocumented
+
+ \return Undocumented
+ \retval <value> Undocumented
+
+ \since Haiku R1
+*/
+
+
+//! \endcond INTERNAL
diff --git a/docs/user/support/Job.dox b/docs/user/support/Job.dox
new file mode 100644
index 0000000000..b44b3ca99a
--- /dev/null
+++ b/docs/user/support/Job.dox
@@ -0,0 +1,385 @@
+/*
+ * Copyright 2020 Haiku, Inc. All rights reserved.
+ * Distributed under the terms of the MIT License.
+ *
+ * Authors:
+ * Name, email@xxxxxxxxx
+ *
+ * Corresponds to:
+ * headers/os/support/Job.h hrev49696
+ * src/kits/support/Job.cpp hrev49696
+ */
+
+
+//! \cond INTERNAL
+
+
+/*!
+ \file Job.h
+ \ingroup support
+ \brief Undocumented file.
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \struct BSupportKit::BJobStateListener
+ \ingroup support
+ \ingroup libbe
+ \brief Undocumented class.
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \fn virtual BSupportKit::BJobStateListener::~BJobStateListener()
+ \brief Undocumented destructor
+
+ \return Undocumented
+ \retval <value> Undocumented
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \fn virtual void BSupportKit::BJobStateListener::JobAborted(BJob *job)
+ \brief Undocumented public method
+
+ \param job Undocumented
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \fn virtual void BSupportKit::BJobStateListener::JobFailed(BJob *job)
+ \brief Undocumented public method
+
+ \param job Undocumented
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \fn virtual void BSupportKit::BJobStateListener::JobProgress(BJob *job)
+ \brief Undocumented public method
+
+ \param job Undocumented
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \fn virtual void BSupportKit::BJobStateListener::JobStarted(BJob *job)
+ \brief Undocumented public method
+
+ \param job Undocumented
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \fn virtual void BSupportKit::BJobStateListener::JobSucceeded(BJob *job)
+ \brief Undocumented public method
+
+ \param job Undocumented
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \enum BSupportKit::BJobState
+ \brief Undocumented enum
+*/
+
+
+/*!
+ \var BJobState BSupportKit::B_JOB_STATE_WAITING_TO_RUN
+ \brief Undocumented
+*/
+
+
+/*!
+ \var BJobState BSupportKit::B_JOB_STATE_STARTED
+ \brief Undocumented
+*/
+
+
+/*!
+ \var BJobState BSupportKit::B_JOB_STATE_IN_PROGRESS
+ \brief Undocumented
+*/
+
+
+/*!
+ \var BJobState BSupportKit::B_JOB_STATE_SUCCEEDED
+ \brief Undocumented
+*/
+
+
+
+/*!
+ \var BJobState BSupportKit::B_JOB_STATE_FAILED
+ \brief Undocumented
+*/
+
+
+/*!
+ \var BJobState BSupportKit::B_JOB_STATE_ABORTED
+ \brief Undocumented
+*/
+
+
+/*!
+ \class BSupportKit::BJob
+ \ingroup support
+ \ingroup libbe
+ \brief Undocumented class.
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \fn BSupportKit::BJob::BJob(const BString &title)
+ \brief Undocumented constructor
+
+ \param title Undocumented
+
+ \return Undocumented
+ \retval <value> Undocumented
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \fn virtual BSupportKit::BJob::~BJob()
+ \brief Undocumented destructor
+
+ \return Undocumented
+ \retval <value> Undocumented
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \fn status_t BSupportKit::BJob::AddDependency(BJob *job)
+ \brief Undocumented public method
+
+ \param job Undocumented
+
+ \return Undocumented
+ \retval <value> Undocumented
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \fn status_t BSupportKit::BJob::AddStateListener(BJobStateListener
*listener)
+ \brief Undocumented public method
+
+ \param listener Undocumented
+
+ \return Undocumented
+ \retval <value> Undocumented
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \fn int32 BSupportKit::BJob::CountDependencies() const
+ \brief Undocumented public method
+
+ \return Undocumented
+ \retval <value> Undocumented
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \fn BJob* BSupportKit::BJob::DependantJobAt(int32 index) const
+ \brief Undocumented public method
+
+ \param index Undocumented
+
+ \return Undocumented
+ \retval <value> Undocumented
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \fn const BString& BSupportKit::BJob::ErrorString() const
+ \brief Undocumented public method
+
+ \return Undocumented
+ \retval <value> Undocumented
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \fn status_t BSupportKit::BJob::InitCheck() const
+ \brief Undocumented public method
+
+ \return Undocumented
+ \retval <value> Undocumented
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \fn bool BSupportKit::BJob::IsRunnable() const
+ \brief Undocumented public method
+
+ \return Undocumented
+ \retval <value> Undocumented
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \fn status_t BSupportKit::BJob::RemoveDependency(BJob *job)
+ \brief Undocumented public method
+
+ \param job Undocumented
+
+ \return Undocumented
+ \retval <value> Undocumented
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \fn status_t BSupportKit::BJob::RemoveStateListener(BJobStateListener
*listener)
+ \brief Undocumented public method
+
+ \param listener Undocumented
+
+ \return Undocumented
+ \retval <value> Undocumented
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \fn status_t BSupportKit::BJob::Result() const
+ \brief Undocumented public method
+
+ \return Undocumented
+ \retval <value> Undocumented
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \fn virtual status_t BSupportKit::BJob::Run()
+ \brief Undocumented public method
+
+ \return Undocumented
+ \retval <value> Undocumented
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \fn BJobState BSupportKit::BJob::State() const
+ \brief Undocumented public method
+
+ \return Undocumented
+ \retval <value> Undocumented
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \fn uint32 BSupportKit::BJob::TicketNumber() const
+ \brief Undocumented public method
+
+ \return Undocumented
+ \retval <value> Undocumented
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \fn const BString& BSupportKit::BJob::Title() const
+ \brief Undocumented public method
+
+ \return Undocumented
+ \retval <value> Undocumented
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \fn virtual void BSupportKit::BJob::Cleanup(status_t jobResult)
+ \brief Undocumented protected method
+
+ \param jobResult Undocumented
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \fn virtual status_t BSupportKit::BJob::Execute()=0
+ \brief Undocumented protected method
+
+ \return Undocumented
+ \retval <value> Undocumented
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \fn void BSupportKit::BJob::NotifyStateListeners()
+ \brief Undocumented protected method
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \fn void BSupportKit::BJob::SetErrorString(const BString &)
+ \brief Undocumented protected method
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \fn void BSupportKit::BJob::SetState(BJobState state)
+ \brief Undocumented protected method
+
+ \param state Undocumented
+
+ \since Haiku R1
+*/
+
+
+//! \endcond INTERNAL
############################################################################
Commit: 5a6d68bbfa79ce51941dcd50aa44cca1fab4e58b
URL: https://git.haiku-os.org/haiku/commit/?id=5a6d68bbfa79
Author: Niels Sascha Reedijk <niels.reedijk@xxxxxxxxx>
Date: Fri Oct 9 06:23:59 2020 UTC
Committer: waddlesplash <waddlesplash@xxxxxxxxx>
Commit-Date: Sun Oct 11 15:46:06 2020 UTC
HaikuBook: add instructions for including INTERNAL documentation
Change-Id: Ifb539a0a11d6aa9f496aa493d7a47a08016818be
Reviewed-on: https://review.haiku-os.org/c/haiku/+/3308
Reviewed-by: waddlesplash <waddlesplash@xxxxxxxxx>
----------------------------------------------------------------------------
diff --git a/docs/user/apidoc.dox b/docs/user/apidoc.dox
index 0e64c0404d..81ba8569c9 100644
--- a/docs/user/apidoc.dox
+++ b/docs/user/apidoc.dox
@@ -1,6 +1,6 @@
/*
* Copyright 2007 Niels Sascha Reedijk. All rights reserved.
- * Copyright 2008-2013 Haiku, Inc. All rights reserved.
+ * Copyright 2008-2013, 2020 Haiku, Inc. All rights reserved.
* Distributed under the terms of the MIT License.
*
* Authors:
@@ -185,6 +185,29 @@
\note This is only for the source files and for you as documenter. It
will
not show up in the actual generated documentation!
+ \subsection formalrequirements_internal Internal documentation
+
+ It is possible that there is documentation for parts of the API that are
+ not (yet) part of the public API. It could either be that the
documentation
+ is part of the public header file (usually hidden behind a namespace
like
+ \c BPrivate), or it is part of a private header file.
+
+ In case you are in the situation where you need to store private API
docs,
+ you should put the entirety of the documentation in a conditional block,
+ with the \c INTERNAL identifier. You open the block with the command
+ <tt>//! \\cond INTERNAL</tt> and end the block with the command
+ <tt>//! \\endcond INTERNAL</tt>.
+
+ There are two different cases where you must or could use these blocks:
+
+ 1. For non-public API of a <em>public header file</em>, you must always
+ add the classes and other elements to the documentation (even
if they)
+ are placeholders, and put them in the conditional block.
+ 2. For parts of the non-public API that is in a <em>private header
+ file</em>, you could put the documentation in a conditional
block. If
+ you choose to do so, you must document all elements in that
header
+ file.
+
\section commands Doxygen Commands
This section describes all the Doxygen commands that will be used in the
############################################################################
Revision: hrev54631
Commit: 1e22d0d338bebf75b9ed8f69cd99fe3554d86fda
URL: https://git.haiku-os.org/haiku/commit/?id=1e22d0d338be
Author: Niels Sascha Reedijk <niels.reedijk@xxxxxxxxx>
Date: Sun Oct 11 14:41:42 2020 UTC
Committer: waddlesplash <waddlesplash@xxxxxxxxx>
Commit-Date: Sun Oct 11 15:46:06 2020 UTC
HaikuBook: Improvements to the GraphicsDefs.h documentations
Still lots more to do, but it is a start.
Change-Id: Ia83e7f4b751a860b3005d34841b58f31450613ce
Reviewed-on: https://review.haiku-os.org/c/haiku/+/3309
Reviewed-by: waddlesplash <waddlesplash@xxxxxxxxx>
----------------------------------------------------------------------------
diff --git a/docs/user/interface/GraphicsDefs.dox
b/docs/user/interface/GraphicsDefs.dox
index fad072167f..ccdb0cd5fe 100644
--- a/docs/user/interface/GraphicsDefs.dox
+++ b/docs/user/interface/GraphicsDefs.dox
@@ -1,13 +1,14 @@
/*
- * Copyright 2013 Haiku, Inc. All rights reserved.
+ * Copyright 2013, 2020 Haiku, Inc. All rights reserved.
* Distributed under the terms of the MIT License.
*
* Authors:
* John Scipione, jscipione@xxxxxxxxx
+ * Niels Sascha Reedijk, niels.reedijk@xxxxxxxxx
*
* Corresponds to:
- * headers/os/interface/GraphicsDefs.h hrev45737
- * src/kits/interface/GraphicsDefs.cpp hrev45737
+ * headers/os/interface/GraphicsDefs.h hrev54374
+ * src/kits/interface/GraphicsDefs.cpp hrev49977
*/
@@ -19,6 +20,17 @@
*/
+///// Pattern /////
+
+
+/*!
+ \name Patterns
+*/
+
+
+//! @{
+
+
/*!
\struct pattern
\ingroup interface
@@ -29,6 +41,28 @@
*/
+/*!
+ \fn bool operator==(const pattern &a, const pattern &b)
+ \brief Comparison operator for two patterns
+
+ \retval true The patterns match
+ \retval false The patterns do not match
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \fn bool operator!=(const pattern &a, const pattern &b)
+ \brief Comparison operator for two patterns
+
+ \retval true The patterns do not match
+ \retval false The patterns match
+
+ \since Haiku R1
+*/
+
+
/*!
\var B_SOLID_HIGH
@@ -55,6 +89,262 @@
\since BeOS R3
*/
+//! @}
+
+
+///// struct rgb_color /////
+
+
+/*!
+ \name RGB Colors
+*/
+
+
+//! @{
+
+
+/*!
+ \struct rgb_color
+ \ingroup interface
+ \ingroup libbe
+ \brief Structure representing a 32 bit RGBA color.
+
+ \since BeOS R3
+*/
+
+
+/*!
+ \var uint8 rgb_color::red
+ \brief Red value for the color.
+
+ \since BeOS R3
+*/
+
+
+/*!
+ \var uint8 rgb_color::green
+ \brief Green value for the color.
+
+ \since BeOS R3
+*/
+
+
+/*!
+ \var uint8 rgb_color::blue
+ \brief Blue value for the color.
+
+ \since BeOS R3
+*/
+
+
+/*!
+ \var uint8 rgb_color::alpha
+ \brief Alpha value for the color.
+
+ \since BeOS R3
+*/
+
+
+/*!
+ \fn rgb_color& rgb_color::set_to(uint8 r, uint8 g, uint8 b, uint8 a=255)
+ \brief Helper method to set all values of the color.
+
+ \param r Red value.
+ \param g Green value.
+ \param b Blue value.
+ \param a Alpha value.
+
+ \return A reference to this object.
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \fn bool rgb_color::operator==(const rgb_color &other) const
+ \brief Comparison operator.
+
+ \param other The other color to compare to.
+
+ \retval true The colors match.
+ \retval false The colors are different.
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \fn bool rgb_color::operator!=(const rgb_color &other) const
+ \brief Comparison operator.
+
+ \param other The other color to compare to.
+
+ \retval true The colors are different.
+ \retval false The colors match.
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \fn rgb_color& rgb_color::operator=(const rgb_color &other)
+ \brief Assign values from another color object.
+
+ \param other The other color to copy.
+
+ \return A reference to this object.
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \fn int32 rgb_color::Brightness() const
+ \brief Calculates a value representing the brightness of this color.
+
+ This method uses a fast algorithm to calculate the brightness in Luma of
+ the color.
+
+ \return A value representing the brightness.
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \fn rgb_color make_color(uint8 red, uint8 green, uint8 blue, uint8
alpha=255)
+ \brief Create a \a rgb_color from RGBA values.
+
+ \param red The value for red.
+ \param green The value for green.
+ \param blue The value for blue.
+ \param alpha The alpha value. Set to opaque by default.
+
+ \return A new rgb_color set to the selected colors.
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \fn rgb_color mix_color(rgb_color color1, rgb_color color2, uint8
amount)
+ \brief Mix two colors without respect for their alpha values.
+
+ \param color1 First color.
+ \param color2 Second color.
+ \param amount The relative weight of \a color1 to mix in.
+
+ \return The newly-mixed \ref rgb_color.
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \fn rgb_color blend_color(rgb_color color1, rgb_color color2, uint8
amount)
+ \brief Mix two colors, respecting their alpha values.
+
+ \param color1 First color.
+ \param color2 Second color.
+ \param amount The relative weight of \a color1 to mix in.
+
+ \return The newly-mixed \ref rgb_color.
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \fn rgb_color disable_color(rgb_color color, rgb_color background)
+ \brief Calculate a color for a disabled look.
+
+ \param color The color that it would be if the use of your color is \em
not
+ disabled.
+ \param background The background on which will be drawn.
+
+ \return A newly-mixed \ref rgb_color.
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \var const rgb_color B_TRANSPARENT_COLOR
+ \brief A transparent color.
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \var const uint8 B_TRANSPARENT_MAGIC_CMAP8
+ \brief Transparent color.
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \var const uint16 B_TRANSPARENT_MAGIC_RGBA15
+ \brief Transparent color.
+
+ \since Haiku R1
+*/
[ *** diff truncated: 65 lines dropped *** ]
