liblzma: Improve documentation in index.h
[xz/debian.git] / src / common / tuklib_physmem.h
blob09e2a51338ae798e09213124c55a955738b8f68f
1 ///////////////////////////////////////////////////////////////////////////////
2 //
3 /// \file tuklib_physmem.h
4 /// \brief Get the amount of physical memory
5 //
6 // Author: Lasse Collin
7 //
8 // This file has been put into the public domain.
9 // You can do whatever you want with this file.
11 ///////////////////////////////////////////////////////////////////////////////
13 #ifndef TUKLIB_PHYSMEM_H
14 #define TUKLIB_PHYSMEM_H
16 #include "tuklib_common.h"
17 TUKLIB_DECLS_BEGIN
19 #define tuklib_physmem TUKLIB_SYMBOL(tuklib_physmem)
20 extern uint64_t tuklib_physmem(void);
21 ///<
22 /// \brief Get the amount of physical memory in bytes
23 ///
24 /// \return Amount of physical memory in bytes. On error, zero is
25 /// returned.
27 TUKLIB_DECLS_END
28 #endif