aboutsummaryrefslogtreecommitdiff
path: root/doc/api/cplusplus/main_page.doxygen
blob: 3e79a6ef25ed0fa85577c274ced31ad8cd00a59e (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
/* vim: set ft=cpp tw=80 sw=4 et : */

/** \mainpage

This is the Paludis core API documentation.

To find your way around:

- Use the <a href="modules.html">Modules</a> link, rather than trying to browse through
  raw class lists.
- See the <a href="examples.html">Examples</a>.

Some classes you may find useful:

- paludis::Environment, which is usually created using paludis::EnvironmentFactory
- paludis::PackageID, which you can get from your paludis::Environment by using a paludis::Selection
- paludis::PackageDatabase
- paludis::Repository and the associated interface classes

*/