aboutsummaryrefslogtreecommitdiffstats
path: root/staging_vespalib/src/vespa/vespalib/util/overview.h
blob: 6735fba649975c0c441d52a97f5c1c3bf4e75d96 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
// Copyright 2017 Yahoo Holdings. Licensed under the terms of the Apache 2.0 license. See LICENSE in the project root.
/*! \mainpage Vespalib - C++ utility library for Vespa components
 *
 * \section intro_sec Introduction
 *
 * vespalib is a collection of simple utility classes shared
 * between most Vespa components that are written in C++.
 * Most of these aren't Vespa specific in any way, except that
 * they reflect the Vespa code standard and conventions.
 *
 * \section install_sec Installation
 *
 * install vespa_vespalib_dev
 *
 * \section overview_sec Overview
 *
 * Most of the classes in vespalib can be used by themselves,
 * for a full list see the alphabetical class list.
 * Here are the major groups of classes:
 *
 * Generation counter
 *
 * vespalib::GenCnt
 *
 * Reference counting and atomic operations
 *
 * <BR> vespalib::ReferenceCounter	
 *
 * Simple hashmap
 *
 * \ref vespalib::HashMap<T>
 *
 * Scope guards for easier exception-safety
 *
 * vespalib::CounterGuard	
 * <BR> vespalib::DirPointer
 * <BR> vespalib::FileDescriptor	
 * <BR> vespalib::FilePointer	
 * <BR> \ref vespalib::MaxValueGuard<T>	
 * <BR> \ref vespalib::ValueGuard<T>	
 *
 * General utility macros
 * <BR> \ref VESPA_STRLOC
 * <BR> \ref VESPA_STRINGIZE(str)
 *
 * Standalone testing framework
 *
 * vespalib::TestApp	
 */