HaikuBook: fix some errors and warnings during documentation generation
Change-Id: Ib6b876ff83aeba0d2346990ab2e9869cbf519284 Reviewed-on: https://review.haiku-os.org/c/haiku/+/6641 Tested-by: Commit checker robot <[email protected]> Reviewed-by: Adrien Destugues <[email protected]>
This commit is contained in:
committed by
waddlesplash
parent
8872deb057
commit
4958c5d7b6
@@ -931,6 +931,7 @@ INPUT = . \
|
|||||||
../../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_isochronous.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 \
|
||||||
@@ -941,6 +942,7 @@ INPUT = . \
|
|||||||
../../headers/os/midi2 \
|
../../headers/os/midi2 \
|
||||||
../../headers/os/net \
|
../../headers/os/net \
|
||||||
../../headers/private/netservices2 \
|
../../headers/private/netservices2 \
|
||||||
|
../../headers/private/shared/MemoryRingIO.h \
|
||||||
../../headers/os/storage \
|
../../headers/os/storage \
|
||||||
../../headers/os/support \
|
../../headers/os/support \
|
||||||
../../headers/os/translation \
|
../../headers/os/translation \
|
||||||
|
|||||||
@@ -27,7 +27,7 @@
|
|||||||
The implementation is based around the following concepts:
|
The implementation is based around the following concepts:
|
||||||
- The \b keystore is the centralized repository for your keys. It is
|
- The \b keystore is the centralized repository for your keys. It is
|
||||||
managed by the \b keystore_server and it contains one or more
|
managed by the \b keystore_server and it contains one or more
|
||||||
\b keyrings.
|
\b keyrings.
|
||||||
- A \b keyring is a collection of keys. There is always a
|
- A \b keyring is a collection of keys. There is always a
|
||||||
\b master \b keyring, which cannot be removed. Access is organized
|
\b master \b keyring, which cannot be removed. Access is organized
|
||||||
around keyrings. From a user's perspective, when an application wants
|
around keyrings. From a user's perspective, when an application wants
|
||||||
@@ -61,7 +61,7 @@
|
|||||||
the \c keystore_server will prompt the user to grant (or deny) access to
|
the \c keystore_server will prompt the user to grant (or deny) access to
|
||||||
your application, when it wants to access a keyring, this again does not
|
your application, when it wants to access a keyring, this again does not
|
||||||
prevent any malicious actor to bypass the \c keystore_server and directly
|
prevent any malicious actor to bypass the \c keystore_server and directly
|
||||||
read from (and write to!) the file.
|
read from (and write to!) the file.
|
||||||
|
|
||||||
When considering on whether to use the current API, there are a few things
|
When considering on whether to use the current API, there are a few things
|
||||||
to think about:
|
to think about:
|
||||||
@@ -201,7 +201,7 @@
|
|||||||
Instead of building one monolithic application, we make several small tools
|
Instead of building one monolithic application, we make several small tools
|
||||||
with specific jobs for this cool web service. One of the tools does the
|
with specific jobs for this cool web service. One of the tools does the
|
||||||
authentication, and stores the key in the master keyring on the system. The
|
authentication, and stores the key in the master keyring on the system. The
|
||||||
other tools use this key to access the API.
|
other tools use this key to access the API.
|
||||||
|
|
||||||
Each tool requires the authentication token to be set up properly. That's
|
Each tool requires the authentication token to be set up properly. That's
|
||||||
why in the \ref BApplication::ReadyToRun() hook we check for the
|
why in the \ref BApplication::ReadyToRun() hook we check for the
|
||||||
|
|||||||
@@ -11,7 +11,7 @@
|
|||||||
\page interface_intro Introduction to the Interface Kit
|
\page interface_intro Introduction to the Interface Kit
|
||||||
\ingroup interface
|
\ingroup interface
|
||||||
|
|
||||||
\section Overview
|
\section Interface Overview
|
||||||
|
|
||||||
The Interface Kit holds all the classes you'll need to develop a GUI.
|
The Interface Kit holds all the classes you'll need to develop a GUI.
|
||||||
Building on the messaging facilities provided by the Application Kit,
|
Building on the messaging facilities provided by the Application Kit,
|
||||||
@@ -20,7 +20,7 @@
|
|||||||
|
|
||||||
The most important class in the Interface Kit is the BView class, which
|
The most important class in the Interface Kit is the BView class, which
|
||||||
handles drawing and user interaction. Pointer and keyboard events are
|
handles drawing and user interaction. Pointer and keyboard events are
|
||||||
processed in this class.
|
processed in this class.
|
||||||
|
|
||||||
Another important class is the BWindow class, which holds BViews and makes
|
Another important class is the BWindow class, which holds BViews and makes
|
||||||
them visible to the user. The BWindow class also handles BView focusing
|
them visible to the user. The BWindow class also handles BView focusing
|
||||||
@@ -29,7 +29,7 @@
|
|||||||
A new addition Haiku has added over the BeOS API is the Layout API, which
|
A new addition Haiku has added over the BeOS API is the Layout API, which
|
||||||
is based around the BLayoutItem and BLayout classes. These classes will
|
is based around the BLayoutItem and BLayout classes. These classes will
|
||||||
take care of making sure all your GUI widgets end up where you want them,
|
take care of making sure all your GUI widgets end up where you want them,
|
||||||
with enough space to be useful. You can start learning the Layout API
|
with enough space to be useful. You can start learning the Layout API
|
||||||
by reading the \ref layout_intro.
|
by reading the \ref layout_intro.
|
||||||
|
|
||||||
\section coordinatespaces Coordinate spaces
|
\section coordinatespaces Coordinate spaces
|
||||||
|
|||||||
@@ -38,7 +38,7 @@
|
|||||||
look at the overview, or go straight to the complete
|
look at the overview, or go straight to the complete
|
||||||
\link support list of components \endlink of this kit.
|
\link support list of components \endlink of this kit.
|
||||||
|
|
||||||
\section Overview
|
\section Support Overview
|
||||||
- Thread Safety:
|
- Thread Safety:
|
||||||
- BLocker provides a semaphore-like locking mechanism allowing for
|
- BLocker provides a semaphore-like locking mechanism allowing for
|
||||||
recursive locks.
|
recursive locks.
|
||||||
@@ -79,7 +79,7 @@
|
|||||||
|
|
||||||
|
|
||||||
// Short listing of documents that belong to this module so that people can
|
// Short listing of documents that belong to this module so that people can
|
||||||
// find these from the module overview.
|
// find these from the module overview.
|
||||||
// This should become standardized in Doxygen though. There is an item on
|
// This should become standardized in Doxygen though. There is an item on
|
||||||
// the todo list on this.
|
// the todo list on this.
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user