Aren/haiku
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

HaikuBook: fix part of the warnings marked by Doxygen

Browse Source 
I spotted some warnings when I upgraded from Doxygen 1.18.13 to 1.18.17.
The new warnings are useful, they point out imbalances in grouping, as
well as unclosed comment blocks. Coincidentally, this fixes #13338
This commit is contained in:
Niels Sascha Reedijk 2020-03-01 09:48:11 +00:00
parent 7a8d5a2db3
commit ff1ee776fe
16 changed files with 31 additions and 158 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
docs/user/Doxyfile
View File

@ -816,7 +816,8 @@ INPUT = . \
../../headers/os/support \
../../headers/os/translation \
../../headers/posix/syslog.h \
../../src/kits/game/GameProducer.h
../../src/kits/game/GameProducer.h \
../../headers/private/shared/Geolocation.h
# This tag can be used to specify the character encoding of the source files
# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses

2
docs/user/app/Application.dox
View File

@ -688,4 +688,4 @@ main()
*/
//! @{
//! @}

13
docs/user/drivers/fs_interface.dox
View File

@ -1296,6 +1296,8 @@
\name Directory Operations
*/
//! @{
/*!
\fn status_t (*fs_vnode_ops::create_dir)(fs_volume *volume,
fs_vnode *parent, const char *name, int perms)
@ -1683,7 +1685,7 @@
\name Node and FS Layers
*/
//! {@
//! @{
/*!
\fn status_t (*fs_vnode_ops::create_special_node)(fs_volume *volume,
@ -1704,6 +1706,12 @@
///// Vnode functions /////
/*!
\name Vnode functions
*/
//! @{
/*!
\fn status_t new_vnode(fs_volume *volume, ino_t vnodeID, void *privateNode,
fs_vnode_ops *ops)
@ -1870,6 +1878,7 @@
\return The volume object for the given vnode.
*/
//! @}
///// Notification Functions
@ -1884,6 +1893,8 @@
that changed.
*/
//! @{
/*!
\fn status_t notify_entry_created(dev_t device, ino_t directory,
const char *name, ino_t node)

4
docs/user/interface/AbstractLayout.dox
View File

@ -56,7 +56,7 @@
*/
//@}
//! @}
/*!
@ -147,4 +147,4 @@
*/
//@}
//! @}

1
docs/user/interface/Box.dox
View File

@ -10,6 +10,7 @@
* Corresponds to:
* headers/os/interface/Box.h rev 42274
* src/kits/interface/Box.cpp rev 42274
*/
/*!

1
docs/user/interface/Button.dox
View File

@ -8,6 +8,7 @@
* Corresponds to:
* headers/os/interface/Button.h hrev47274
* src/kits/interface/Button.cpp hrev47273
*/
/*!

1
docs/user/interface/Dragger.dox
View File

@ -8,6 +8,7 @@
* Corresponds to:
* headers/os/interface/Dragger.h hrev45050
* src/kits/interface/Dragger.cpp hrev45050
*/
/*!

139
docs/user/interface/LayoutBuilder.dox
View File

@ -122,142 +122,3 @@ BLayoutBuilder::Group<>(B_HORIZONTAL)
\since Haiku R1
*/
/*
template<typename ParentBuilder>
class Grid : public Base<ParentBuilder> {
public:
typedef Grid<ParentBuilder> ThisBuilder;
typedef Group<ThisBuilder> GroupBuilder;
typedef Grid<ThisBuilder> GridBuilder;
typedef Split<ThisBuilder> SplitBuilder;
public:
inline Grid(float horizontalSpacing = 0.0f,
float verticalSpacing = 0.0f);
inline Grid(BWindow* window,
float horizontalSpacing = 0.0f,
float verticalSpacing = 0.0f);
inline Grid(BGridLayout* layout);
inline Grid(BGridView* view);
inline BGridLayout* Layout() const;
inline BView* View() const;
inline ThisBuilder& GetLayout(BGridLayout** _layout);
inline ThisBuilder& GetView(BView** _view);
inline ThisBuilder& Add(BView* view, int32 column, int32 row,
int32 columnCount = 1, int32 rowCount = 1);
inline ThisBuilder& Add(BLayoutItem* item, int32 column, int32 row,
int32 columnCount = 1, int32 rowCount = 1);
inline ThisBuilder& AddMenuField(BMenuField* menuField,
int32 column, int32 row,
alignment labelAlignment
= B_ALIGN_HORIZONTAL_UNSET,
int32 columnCount = 1, int32 rowCount = 1);
inline ThisBuilder& AddTextControl(BTextControl* textControl,
int32 column, int32 row,
alignment labelAlignment
= B_ALIGN_HORIZONTAL_UNSET,
int32 columnCount = 1, int32 rowCount = 1);
inline GroupBuilder AddGroup(orientation orientation,
float spacing, int32 column, int32 row,
int32 columnCount = 1, int32 rowCount = 1);
inline GroupBuilder AddGroup(BGroupView* groupView, int32 column,
int32 row, int32 columnCount = 1,
int32 rowCount = 1);
inline GroupBuilder AddGroup(BGroupLayout* groupLayout,
int32 column, int32 row,
int32 columnCount = 1, int32 rowCount = 1);
inline GridBuilder AddGrid(float horizontalSpacing,
float verticalSpacing, int32 column,
int32 row, int32 columnCount = 1,
int32 rowCount = 1);
inline GridBuilder AddGrid(BGridLayout* gridLayout,
int32 column, int32 row,
int32 columnCount = 1, int32 rowCount = 1);
inline GridBuilder AddGrid(BGridView* gridView,
int32 column, int32 row,
int32 columnCount = 1, int32 rowCount = 1);
inline SplitBuilder AddSplit(orientation orientation,
float spacing, int32 column, int32 row,
int32 columnCount = 1, int32 rowCount = 1);
inline SplitBuilder AddSplit(BSplitView* splitView, int32 column,
int32 row, int32 columnCount = 1,
int32 rowCount = 1);
inline ThisBuilder& SetColumnWeight(int32 column, float weight);
inline ThisBuilder& SetRowWeight(int32 row, float weight);
inline ThisBuilder& SetInsets(float left, float top, float right,
float bottom);
inline operator BGridLayout*();
private:
BGridLayout* fLayout;
};
template<typename ParentBuilder>
class Split : public Base<ParentBuilder> {
public:
typedef Split<ParentBuilder> ThisBuilder;
typedef Group<ThisBuilder> GroupBuilder;
typedef Grid<ThisBuilder> GridBuilder;
typedef Split<ThisBuilder> SplitBuilder;
public:
inline Split(orientation orientation = B_HORIZONTAL,
float spacing = 0.0f);
inline Split(BSplitView* view);
inline BSplitView* View() const;
inline ThisBuilder& GetView(BView** _view);
inline ThisBuilder& GetSplitView(BSplitView** _view);
inline ThisBuilder& Add(BView* view);
inline ThisBuilder& Add(BView* view, float weight);
inline ThisBuilder& Add(BLayoutItem* item);
inline ThisBuilder& Add(BLayoutItem* item, float weight);
inline GroupBuilder AddGroup(orientation orientation,
float spacing = 0.0f, float weight = 1.0f);
inline GroupBuilder AddGroup(BGroupView* groupView,
float weight = 1.0f);
inline GroupBuilder AddGroup(BGroupLayout* groupLayout,
float weight = 1.0f);
inline GridBuilder AddGrid(float horizontalSpacing = 0.0f,
float verticalSpacing = 0.0f,
float weight = 1.0f);
inline GridBuilder AddGrid(BGridView* gridView,
float weight = 1.0f);
inline GridBuilder AddGrid(BGridLayout* gridLayout,
float weight = 1.0f);
inline SplitBuilder AddSplit(orientation orientation,
float spacing = 0.0f, float weight = 1.0f);
inline SplitBuilder AddSplit(BSplitView* splitView,
float weight = 1.0f);
inline ThisBuilder& SetCollapsible(bool collapsible);
inline ThisBuilder& SetCollapsible(int32 index, bool collapsible);
inline ThisBuilder& SetCollapsible(int32 first, int32 last,
bool collapsible);
inline ThisBuilder& SetInsets(float left, float top, float right,
float bottom);
inline operator BSplitView*();
private:
BSplitView* fView;
};

1
docs/user/interface/TabView.dox
View File

@ -592,6 +592,7 @@
/*!
\fn void BTabView::FrameResized(float newWidth, float newHeight)
\copydoc BView::FrameResized()
*/
/*!

1
docs/user/interface/TextView.dox
View File

@ -490,6 +490,7 @@
\see IsStylable()
*/
//! @{
/*!
\fn void BTextView::Insert(const char* text, const text_run_array* runs)

3
docs/user/interface/View.dox
View File

@ -1245,9 +1245,6 @@ SetViewColor(Parent()->ViewColor());
*/
//! @}
/*!
\fn uint32 BView::Flags() const
\brief Return the view flags set in the constructor or by SetFlags().

2
docs/user/locale/Country.dox
View File

@ -93,8 +93,6 @@
\fn status_t BCountry::InitCheck()
\brief Check validity of the BCountry object.
\param countryCode The country code to initialize from.
\returns B_OK if everything went fine, B_BAD_DATA if the specified country
code is not valid, B_NO_MEMORY if the object could not be
allocated properly.

8
docs/user/shared/Geolocation.dox
View File

@ -6,8 +6,8 @@
* Adrien Destugues, pulkomandy@pulkomandy.tk
*
* Corresponds to:
* headers/private/shared/Geolocation.h hrev53489
* src/kits/shared/Geolocation.cpp hrev53489
* headers/private/shared/Geolocation.h hrev53611
* src/kits/shared/Geolocation.cpp hrev53613S
*/
@ -59,8 +59,8 @@
/*!
\fn BGeolocation::BGeolocation(BUrl& geolocationService,
BUrl& geocodingService)
\fn BGeolocation::BGeolocation(const BUrl& geolocationService,
const BUrl& geocodingService)
\brief Initialize a BGeolocation using custom services or API keys.
You can use this constructor to provide your own URL to a webservice to

2
docs/user/storage/Entry.dox
View File

@ -289,7 +289,7 @@ BEntry entry("/boot/home/fido");
\retval B_NO_INIT The object has been Unset() or is uninitialized.
\since BeOS R3
*/
/*!

2
docs/user/support/String.dox
View File

@ -2571,7 +2571,7 @@
*/
// @}
//! @}
/*!

6
docs/user/support/Url.dox
View File

@ -177,7 +177,7 @@
\param authority The authority component.
The username, password, host and port fields are replaced. The authority
can be of the form username:password@host:port
can be of the form username:password\@host:port
*/
/*!
@ -225,7 +225,7 @@
\returns the string representation of the URL.
A complete URL string is of the form protocol://username:passord@host:port/path?request#fragment . All the fields are optional, for example a file URL will
A complete URL string is of the form protocol://username:passord\@host:port/path?request#fragment . All the fields are optional, for example a file URL will
have only a protocol and a path.
*/
@ -282,7 +282,7 @@
\returns The authority url as a string.
The authority is of the form username:password@host:port.
The authority is of the form username:password\@host:port.
*/
/*!