HaikuBook: add remaining layout class documentation
This is the final contribution to #15368 * Tried to share more documentation in the various BLayoutBuilder classes * Add missing GridView, GroupView, SpaceLayoutItem * Also added AbstractLayoutItem, but hide the actual documentation behind an `INTERNAL` conditional block. This block identifier can be used to document parts of the API, to then hide them during a regular Doxygen run. * Do some cleanup on other layout classes; add missing members, etc. * The actual generated BLayoutBuilder::* html is a mess. I should investigate this at a later time. Especially the copied members seem to mix type definitions with member documentation. It is odd. Not unlikely to be a Doxygen bug. * The general documentation for the layout system could use an overhaul as well, but this is for later. Change-Id: I6db9ef105b4ae6de0f1ebb917f86f8b1c0d4ea2e Reviewed-on: https://review.haiku-os.org/c/haiku/+/2491 Reviewed-by: waddlesplash <[email protected]>
This commit is contained in:
committed by
waddlesplash
parent
891edac940
commit
6758018a21
@@ -1,9 +1,9 @@
|
||||
/*
|
||||
* Copyright 2019 Haiku, Inc. All rights reserved.
|
||||
* Copyright 2020 Haiku, Inc. All rights reserved.
|
||||
* Distributed under the terms of the MIT License.
|
||||
*
|
||||
* Authors:
|
||||
* Name, email@email.com
|
||||
* Niels Sascha Reedijk, niels.reedijk@gmail.com
|
||||
*
|
||||
* Corresponds to:
|
||||
* headers/os/interface/AbstractLayoutItem.h hrev43514
|
||||
@@ -11,10 +11,17 @@
|
||||
*/
|
||||
|
||||
|
||||
// The AbstractLayoutItem.h and its BAbstractLayoutItem is considered entirely
|
||||
// internal, and as such should not appear in the documentation.
|
||||
|
||||
|
||||
//! \cond INTERNAL
|
||||
|
||||
|
||||
/*!
|
||||
\file AbstractLayoutItem.h
|
||||
\ingroup layout
|
||||
\brief Undocumented file.
|
||||
\brief Provides the BAbstractLayoutItem class.
|
||||
|
||||
\since Haiku R1
|
||||
*/
|
||||
@@ -24,7 +31,7 @@
|
||||
\class BAbstractLayoutItem
|
||||
\ingroup layout
|
||||
\ingroup libbe
|
||||
\brief Undocumented class.
|
||||
\brief Internal base class for various layouts.
|
||||
|
||||
\since Haiku R1
|
||||
*/
|
||||
@@ -283,3 +290,5 @@
|
||||
|
||||
\since Haiku R1
|
||||
*/
|
||||
|
||||
//! \endcond INTERNAL
|
||||
|
||||
Reference in New Issue
Block a user