From Niels Sascha Reedijk <niels.reedijk@xxxxxxxxx>:
Niels Sascha Reedijk has uploaded this change for review. (
https://review.haiku-os.org/c/haiku/+/3305 ;)
Change subject: HaikuBook: Hide BLaunchRoster and BToolTip documentation from
book
......................................................................
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.
---
M docs/user/Doxyfile
M docs/user/app/LaunchRoster.dox
M docs/user/interface/ToolTip.dox
3 files changed, 282 insertions(+), 4 deletions(-)
git pull ssh://git.haiku-os.org:22/haiku refs/changes/05/3305/1
diff --git a/docs/user/Doxyfile b/docs/user/Doxyfile
index 01fd9b8..7d5c86c 100644
--- a/docs/user/Doxyfile
+++ b/docs/user/Doxyfile
@@ -838,14 +838,14 @@
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 16bdac5..3a9e699 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 @@
//! @}
+
+
+/*!
+ \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 e64f54b..e1dc9c3 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
--
To view, visit https://review.haiku-os.org/c/haiku/+/3305
To unsubscribe, or for help writing mail filters, visit
https://review.haiku-os.org/settings
Gerrit-Project: haiku
Gerrit-Branch: master
Gerrit-Change-Id: I4ac204a600715937ef99d8ff56c4026d06abec3f
Gerrit-Change-Number: 3305
Gerrit-PatchSet: 1
Gerrit-Owner: Niels Sascha Reedijk <niels.reedijk@xxxxxxxxx>
Gerrit-MessageType: newchange
