xref: /haiku/docs/user/support/StackOrHeapArray.dox (revision 17889a8c70dbb3d59c1412f6431968753c767bab)
1/*
2 * Copyright 2019 Haiku, Inc. All rights reserved.
3 * Distributed under the terms of the MIT License.
4 *
5 * Authors:
6 *		Name, email@email.com
7 *
8 * Corresponds to:
9 *		headers/os/support/StackOrHeapArray.h	hrev46669
10 */
11
12
13/*!
14	\file StackOrHeapArray.h
15	\ingroup support
16	\brief Provides the BStackOrHeapArray helper class.
17
18	\since Haiku R1
19*/
20
21
22/*!
23	\class BStackOrHeapArray
24	\ingroup support
25	\ingroup libbe
26	\brief Undocumented class.
27
28	\tparam Type Undocumented parameter
29	\tparam size Undocumented parameter
30
31	\since Haiku R1
32*/
33
34
35/*!
36	\fn BStackOrHeapArray< Type, StackSize >::BStackOrHeapArray(size_t count)
37	\brief Undocumented public method
38
39	\param count Undocumented
40
41	\return Undocumented
42	\retval <value> Undocumented
43
44	\since Haiku R1
45*/
46
47
48/*!
49	\fn BStackOrHeapArray< Type, StackSize >::~BStackOrHeapArray()
50	\brief Undocumented public method
51
52	\return Undocumented
53	\retval <value> Undocumented
54
55	\since Haiku R1
56*/
57
58
59/*!
60	\fn bool BStackOrHeapArray< Type, StackSize >::IsValid() const
61	\brief Undocumented public method
62
63	\return Undocumented
64	\retval <value> Undocumented
65
66	\since Haiku R1
67*/
68
69
70/*!
71	\fn BStackOrHeapArray< Type, StackSize >::operator Type *()
72	\brief Undocumented public method
73
74	\return Undocumented
75	\retval <value> Undocumented
76
77	\since Haiku R1
78*/
79