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 <[email protected]>
This commit is contained in:
Niels Sascha Reedijk
2020-10-11 15:46:06 +00:00
committed by waddlesplash
parent ae78fb3062
commit 42dcaf375d
3 changed files with 282 additions and 4 deletions
+2 -2
View File
@@ -838,14 +838,14 @@ INPUT = . \
support \ support \
translation \ translation \
../../headers/os/app \ ../../headers/os/app \
../../headers/private/app \ ../../headers/private/app/LaunchRoster.h \
../../headers/os/device/Joystick.h \ ../../headers/os/device/Joystick.h \
../../headers/os/drivers/fs_interface.h \ ../../headers/os/drivers/fs_interface.h \
../../headers/os/drivers/USB3.h \ ../../headers/os/drivers/USB3.h \
../../headers/os/drivers/USB_spec.h \ ../../headers/os/drivers/USB_spec.h \
../../headers/os/game \ ../../headers/os/game \
../../headers/os/interface \ ../../headers/os/interface \
../../headers/private/interface \ ../../headers/private/interface/ToolTip.h \
../../headers/os/locale \ ../../headers/os/locale \
../../headers/os/mail \ ../../headers/os/mail \
../../headers/os/media \ ../../headers/os/media \
+153
View File
@@ -11,6 +11,9 @@
*/ */
//! \cond INTERNAL
/*! /*!
\file LaunchRoster.h \file LaunchRoster.h
\ingroup app \ingroup app
@@ -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
+125
View File
@@ -13,6 +13,9 @@
*/ */
//! \cond INTERNAL
/*! /*!
\file ToolTip.h \file ToolTip.h
\ingroup interface \ingroup interface
@@ -149,3 +152,125 @@
\since Haiku R1 \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