From 6ec9625a36f7a382c68f1a5ab57785f9767d8ad2 Mon Sep 17 00:00:00 2001 From: Adrien Destugues Date: Fri, 4 Oct 2013 16:52:49 +0200 Subject: [PATCH] Fix mismatched prototypes in the Haiku Book. --- docs/user/interface/GridLayout.dox | 2 +- docs/user/interface/Layout.dox | 4 ++-- docs/user/locale/Catalog.dox | 2 +- docs/user/locale/Collator.dox | 8 ++++---- docs/user/locale/LocaleRoster.dox | 21 ++++++++++++++++----- docs/user/locale/TimeZone.dox | 3 ++- docs/user/support/Locker.dox | 2 +- 7 files changed, 27 insertions(+), 15 deletions(-) diff --git a/docs/user/interface/GridLayout.dox b/docs/user/interface/GridLayout.dox index 60194435d0..bbce8ac8da 100644 --- a/docs/user/interface/GridLayout.dox +++ b/docs/user/interface/GridLayout.dox @@ -190,7 +190,7 @@ /*! - \fn float BGridLayout::MinRowHeight(int32 row) const + \fn float BGridLayout::MinRowHeight(int row) const \brief Returns the minimum height for \a row. */ diff --git a/docs/user/interface/Layout.dox b/docs/user/interface/Layout.dox index 0b322cad9a..19e2e065ee 100644 --- a/docs/user/interface/Layout.dox +++ b/docs/user/interface/Layout.dox @@ -280,7 +280,7 @@ topLayout->AddItem(nestedLayoutWithView); /*! - \fn bool BLayout::AncestorsVisible() + \fn bool BLayout::AncestorsVisible() const \brief Get the visibility of the ancestors of this layout. If a BLayout is connected to a BView, this will always return \c true. @@ -352,7 +352,7 @@ topLayout->AddItem(nestedLayoutWithView); /*! - \fn BLayoutContext* BLayout::LayoutContext() + \fn BLayoutContext* BLayout::LayoutContext() const \brief Returns the BLayoutContext this BLayout is currently operating in, or \c NULL. */ diff --git a/docs/user/locale/Catalog.dox b/docs/user/locale/Catalog.dox index e1358965fe..94348aca50 100644 --- a/docs/user/locale/Catalog.dox +++ b/docs/user/locale/Catalog.dox @@ -264,7 +264,7 @@ /*! - \fn int32 BCatalog::CountItems() + \fn int32 BCatalog::CountItems() const \brief Gets the number of items in the catalog. \returns the number of strings in the catalog or 0 on error. diff --git a/docs/user/locale/Collator.dox b/docs/user/locale/Collator.dox index aa4355a6cd..06ead50b8c 100644 --- a/docs/user/locale/Collator.dox +++ b/docs/user/locale/Collator.dox @@ -209,8 +209,8 @@ /*! - \fn bool BCollator::Greater(cosnt char* s1, const char* s2, - int8 strength) const + \fn bool BCollator::Greater(const char* s1, const char* s2, + int8 strength = B_COLLATE_DEFAULT) const \brief Determine if a string is greater than another. \note !Greater(s1, s2) is the same as GreaterOrEqual(s2, s1). This means @@ -225,8 +225,8 @@ /*! - \fn bool BCollator::GreaterOrEqual(cosnt char* s1, const char* s2, - int8 strength) const + \fn bool BCollator::GreaterOrEqual(const char* s1, const char* s2, + int8 strength = B_COLLATE_DEFAULT) const \brief Determines if one string is greater than another. \note !GreaterOrEqual(s1, s2) is the same as Greater(s2, s1). diff --git a/docs/user/locale/LocaleRoster.dox b/docs/user/locale/LocaleRoster.dox index 0ea29fe826..618cf4d6b9 100644 --- a/docs/user/locale/LocaleRoster.dox +++ b/docs/user/locale/LocaleRoster.dox @@ -210,14 +210,25 @@ /*! - \fn BCatalog* BLocaleRoster::_GetCatalog() + \fn BCatalog* BLocaleRoster::_GetCatalog(BCatalog* catalog, + vint32* catalogInitStatus) \brief Get the current image catalog. - This function returns the catalog for the calling image (application, - add-on, or shared library). Note that it doesn't allow to specify a - fingerprint. The language will be selected from the user preferences. + This function initializes and returns the catalog for the calling image + (application, add-on, or shared library). Note that it doesn't allow to + specify a fingerprint. The language will be selected from the user + preferences. - \warning This function needs the image to be lined with liblocalestub.a + This function is used by the Locale Kit macros. + + \warning This function needs the calling image to be linked with + liblocalestub.a \returns The catalog, if it was loaded successfully. + + \param catalog The catalog to load. The pointer location is used to identify + the image for which to load the catalog. + \param catalogInitStatus the state of the catalog. This will be set to true + on the first call for a given catalog, and if already true the function + will do nothing on subsequent calls. */ diff --git a/docs/user/locale/TimeZone.dox b/docs/user/locale/TimeZone.dox index 5359340908..66747a4990 100644 --- a/docs/user/locale/TimeZone.dox +++ b/docs/user/locale/TimeZone.dox @@ -106,7 +106,8 @@ /*! - \fn status_t BTimeZone::SetTo(const char* zoneCode) + \fn status_t BTimeZone::SetTo(const char* zoneCode, + const BLanguage* language = NULL) \brief Set the timezone to another code. \returns \c false if there was an error (likely due to an invalid diff --git a/docs/user/support/Locker.dox b/docs/user/support/Locker.dox index 06076829b5..84169516a6 100644 --- a/docs/user/support/Locker.dox +++ b/docs/user/support/Locker.dox @@ -154,7 +154,7 @@ Flower::Water(int amount) /*! - \fn status_t BLocker::InitCheck() + \fn status_t BLocker::InitCheck() const \brief Check whether the locker has properly initialized \retval B_OK The semaphore has been properly initialized