aboutsummaryrefslogtreecommitdiff
path: root/doc/api/cplusplus/main_page.doxygen
diff options
context:
space:
mode:
authorAvatar Ciaran McCreesh <ciaran.mccreesh@googlemail.com> 2007-10-15 11:10:38 +0000
committerAvatar Ciaran McCreesh <ciaran.mccreesh@googlemail.com> 2007-10-15 11:10:38 +0000
commit503481c165de28bc0a5db25b7848708df7cb2668 (patch)
tree41eac48b7d7915ca0e7e88bb5dc9ea65225d3b99 /doc/api/cplusplus/main_page.doxygen
parent8f51d97de6b38b8bc8a9b129baecf4bebd183c7b (diff)
downloadpaludis-503481c165de28bc0a5db25b7848708df7cb2668.tar.gz
paludis-503481c165de28bc0a5db25b7848708df7cb2668.tar.xz
Start reworking docs
Diffstat (limited to 'doc/api/cplusplus/main_page.doxygen')
-rw-r--r--doc/api/cplusplus/main_page.doxygen20
1 files changed, 20 insertions, 0 deletions
diff --git a/doc/api/cplusplus/main_page.doxygen b/doc/api/cplusplus/main_page.doxygen
new file mode 100644
index 000000000..a54c41717
--- /dev/null
+++ b/doc/api/cplusplus/main_page.doxygen
@@ -0,0 +1,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::EnvironmentMaker
+- paludis::PackageDatabase
+- paludis::Repository and the associated interface classes
+- paludis::PackageID
+
+*/