ExternalVendorCode/genode
1
0
Fork 0
mirror of https://github.com/genodelabs/genode.git synced 2025-06-18 23:28:29 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Revised API documentation

Browse Source 
This patch curates the API documentation to become suitable for the
functional specificaton, which is partially generated from the header
files.
This commit is contained in:
Norman Feske
2015-03-20 17:50:41 +01:00
committed by Christian Helmuth
parent 7441df33c9
commit eaac3cc1bd
107 changed files with 610 additions and 444 deletions
Download Patch File Download Diff File Expand all files Collapse all files

46
repos/base/include/util/avl_tree.h
View File

@ -43,16 +43,16 @@ class Genode::Avl_node_base
* \retval false if n2 is lower than n1
* \retval true if n2 is higher than or equal to n1
*
* This function must be provided by the derived class.
* It determines the order of nodes inside the avl tree.
* This method must be provided by the derived class.
* It determines the order of nodes inside the AVL tree.
*/
virtual bool higher(Avl_node_base *n1, Avl_node_base *n2) const = 0;
/**
* Node recomputation hook
*
* If a node gets rearranged, this function is called.
* It can be used to update avl-tree-position dependent
* If a node gets rearranged, this method is called.
* It can be used to update AVL-tree-position dependent
* meta data.
*/
virtual void recompute(Avl_node_base *) { }
@ -137,30 +137,37 @@ class Genode::Avl_node_base
*
* \param NT type of the class derived from 'Avl_node'
*
* Each object to be stored in the avl tree must be derived from
* 'Avl_node'. The type of the derived class is to be specified as
* template argument to enable 'Avl_node' to call virtual functions
* specific for the derived class.
* Each object to be stored in the AVL tree must be derived from 'Avl_node'.
* The type of the derived class is to be specified as template argument to
* enable 'Avl_node' to call virtual methods specific for the derived class.
*
* The NT class must implement a method called 'higher' that takes a pointer to
* another NT object as argument and returns a bool value. The bool value is
* true if the specified node is higher or equal in the tree order.
*/
template <typename NT>
class Genode::Avl_node : public Avl_node_base
struct Genode::Avl_node : Avl_node_base
{
public:
/**
* Return child of specified side, or nullptr if there is no child
*
* This method can be called by the NT objects to traverse the tree.
*/
inline NT *child(Side i) const { return static_cast<NT *>(_child[i]); }
inline NT *child(Side i) const { return static_cast<NT *>(_child[i]); }
/**
* Default policy
*/
void recompute() { }
/**
* Default policy
*
* \noapi
*/
void recompute() { }
};
/**
* Root node of the AVL tree
*
* The real nodes are always attached at the left branch of
* this root node.
* The real nodes are always attached at the left branch of this root node.
*/
template <typename NT>
class Genode::Avl_tree : Avl_node<NT>
@ -199,8 +206,7 @@ class Genode::Avl_tree : Avl_node<NT>
/**
* Request first node of the tree
*
* \return first node
* \retval NULL if tree is empty
* \return first node, or nullptr if the tree is empty
*/
inline NT *first() const { return this->child(Avl_node<NT>::LEFT); }
};