Ubuntu Platform API  3.0.0
A library helping with tight integration into the Ubuntu platform
/build/platform-api-3.0.2+ubports+0~20210525184302.7~1.gbpa8f95a/doc/mainpage.md
Go to the documentation of this file.
1 Ubuntu Platform API {#mainpage}
2 ===================
3 
4 The Ubuntu platform API Implements access to the Ubuntu platform and
5 is the primary carrier across form-factor boundaries. It serves as a
6 low-level access layer to the underlying system and its capabilities.
7 
8 Intended Audience
9 -----------------
10 
11 The intended audience of this API and its documentation are
12 integrators and developers who either cannot or do not want to rely on
13 the more convenient QML or HTML5/JS SDKs.
14 
15 Source Tree Layout
16 ------------------
17 
18 The overall source tree is split up into roughly two parts:
19 
20  * include/
21  * ubuntu/
22  * application/
23  * sensors/
24  * android/
25 
26 where include contains all of the public types, functions and
27 interfaces offered by the Ubuntu platform API. The android subfolder
28 contains the android-specific implementation of the Ubuntu platform
29 API, together with a default implementation of the C API on top of the
30 generic C++ API. For developers, only the include/ folder and its
31 subdirectories are of interest.
32 
33 Within the include/ folder, only the ubuntu/application/ subfolder is
34 meant for public consumption.