From 080bf8fe19351c11230363077b3b6e1a00192c58 Mon Sep 17 00:00:00 2001 From: John Scipione Date: Mon, 8 Jul 2013 19:02:13 -0400 Subject: [PATCH] Fix rest of warnings, doxygen now runs cleanly. The BTextView::SetText() methods were included twice, update the first and remove the second. --- docs/user/interface/Layout.dox | 4 +++- docs/user/interface/ListItem.dox | 2 +- docs/user/interface/ListView.dox | 19 +++++-------------- docs/user/interface/TextView.dox | 30 +++++++----------------------- 4 files changed, 16 insertions(+), 39 deletions(-) diff --git a/docs/user/interface/Layout.dox b/docs/user/interface/Layout.dox index 627c8ebd61..0b322cad9a 100644 --- a/docs/user/interface/Layout.dox +++ b/docs/user/interface/Layout.dox @@ -528,10 +528,12 @@ topLayout->AddItem(nestedLayoutWithView); /*! - \fn void BLayout::LayoutInvalidated() = 0 + \fn void BLayout::LayoutInvalidated(bool children) Hook method called when this layout becomes invalid. This is a good place to clear any caches your object might hold. + + \param children Whether or not child layouts have also been invalidated. */ diff --git a/docs/user/interface/ListItem.dox b/docs/user/interface/ListItem.dox index 0c6319e6a8..9a2692fd37 100644 --- a/docs/user/interface/ListItem.dox +++ b/docs/user/interface/ListItem.dox @@ -67,7 +67,7 @@ /*! - \fn void DrawItem(BView* owner, BRect frame, bool complete) + \fn void BListItem::DrawItem(BView* owner, BRect frame, bool complete) \brief Hook method called when the item is drawn. \param owner The view that the list item is a child of. diff --git a/docs/user/interface/ListView.dox b/docs/user/interface/ListView.dox index 69475e312f..730b5d8885 100644 --- a/docs/user/interface/ListView.dox +++ b/docs/user/interface/ListView.dox @@ -267,17 +267,6 @@ */ -/*! - \fn void BListView::KeyUp(const char* bytes, int32 numBytes) - \brief Hook method that is called when a keyboard key is released. - - \param bytes The \a bytes representing the keys released. - \param numBytes The size of \a bytes. - - \see BView::KeyUp() -*/ - - /*! \fn void BListView::MouseDown(BPoint point) \brief Hook method that is called when a mouse button is pushed down while @@ -475,7 +464,7 @@ /*! \fn bool BListView::AddList(BList* list) - \fn Add a \a list of list items to the end of the list view. + \brief Add a \a list of list items to the end of the list view. \param list The \a list of list items to add. @@ -698,7 +687,7 @@ /*! - \fn void BListView::DoForEach(bool (*func)(BListItem*)) + \fn void BListView::DoForEach(bool (*func)(BListItem* item)) \brief Calls the specified function on each item in the list. The \a func is called on the items in order starting with the item at index 0 @@ -712,7 +701,8 @@ /*! - \fn void BListView::DoForEach(bool (*func)(BListItem*, void*), void* arg) + \fn void BListView::DoForEach(bool (*func)(BListItem* item, void* arg), + void* arg) \brief Calls the specified function on each item in the list. The \a func is called on the items in order starting with the item at index 0 @@ -723,6 +713,7 @@ as the second argument. \param func The function to call on each item. + \param arg The second argument of the function. */ diff --git a/docs/user/interface/TextView.dox b/docs/user/interface/TextView.dox index 67a5626eda..d504f9917a 100644 --- a/docs/user/interface/TextView.dox +++ b/docs/user/interface/TextView.dox @@ -398,7 +398,8 @@ set in the BTextView with the font and color formats set by \a runs. \param text The text to set. - \param runs The text styling to set, can be \c NULL. + \param runs Set the font and color formats of the new text if provided. Only + applies if the BTextView permits multiple character formats. */ @@ -413,8 +414,9 @@ to 0 to clear the text from the BTextView. \param text The text to set. - \param length The number of bytes of text to set. - \param runs The text styling to use, can be \c NULL. + \param length The maximum number of bytes of \a text to use. + \param runs Set the font and color formats of the new text if provided. Only + applies if the BTextView permits multiple character formats. */ @@ -428,7 +430,8 @@ \param file The file to set the text from. \param offset The position in the file to start reading text. \param length The number of bytes of text to read from the file. - \param runs The text styling to use, can be \c NULL. + \param runs Set the font and color formats of the new text if provided. Only + applies if the BTextView permits multiple character formats. */ @@ -489,25 +492,6 @@ */ -//! @{ - - -/*! - \fn void BTextView::SetText(const char* text, const text_run_array* runs) -*/ - - -/*! - \fn void BTextView::SetText(const char* text, int32 length, - const text_run_array* runs) -*/ - - -/*! - \fn void BTextView::SetText(BFile* file, int32 offset, int32 length, - const text_run_array* runs) -*/ - //! @}