Commit dab4585c authored by Lukas Appelhans's avatar Lukas Appelhans

Much better docu

parent fe1e6bc4
/** @mainpage AkabeiCore API Reference
*
* AkabeiCore is the base library of the akabei package manager of the Chakra Project.
*
* To gather information about available packages, checkout the Akabei::Backend, Akabei::Database and
* Akabei::Package classes. If you are interested in extending the functionality of the processing
* behind AkabeiCore, see Akabei::Operation and Akabei::OperationRunner.
*/
...@@ -26,7 +26,7 @@ class Hook; ...@@ -26,7 +26,7 @@ class Hook;
class BackendPrivate; class BackendPrivate;
/** /**
* \class Backend Akabei/Backend * \class Backend akabeibackend.h "akabeibackend.h"
* *
* \brief Base class of AkabeiCore. * \brief Base class of AkabeiCore.
* *
......
...@@ -18,7 +18,7 @@ class QStringList; ...@@ -18,7 +18,7 @@ class QStringList;
class QDir; class QDir;
namespace Akabei { namespace Akabei {
/** /**
* \class Config Akabei/Config * \class Config akabeiconfig.h "akabeiconfig.h"
* *
* \brief This class just holds certain config values which akabeicore needs to be working. * \brief This class just holds certain config values which akabeicore needs to be working.
*/ */
......
...@@ -19,7 +19,7 @@ namespace Akabei { ...@@ -19,7 +19,7 @@ namespace Akabei {
class DeltaPrivate; class DeltaPrivate;
/** /**
* \class Delta Akabei/Delta * \class Delta akabeidelta.h "akabeidelta.h"
* *
* \brief This class describes a binary patch we use to upgrade from one package version to another. * \brief This class describes a binary patch we use to upgrade from one package version to another.
* *
......
...@@ -19,7 +19,7 @@ class Package; ...@@ -19,7 +19,7 @@ class Package;
class Operation; class Operation;
/** /**
* \class Error Akabei/Error * \class Error akabeierror.h "akabeierror.h"
* *
* \brief Class for describing an error which occurred. * \brief Class for describing an error which occurred.
*/ */
......
...@@ -22,7 +22,7 @@ class Package; ...@@ -22,7 +22,7 @@ class Package;
class GroupPrivate; class GroupPrivate;
/** /**
* \class Group Akabei/Group * \class Group akabeigroup.h "akabeigroup.h"
* *
* \brief This class describes a group of packages. * \brief This class describes a group of packages.
* *
......
...@@ -24,7 +24,7 @@ class Error; ...@@ -24,7 +24,7 @@ class Error;
class OperationPrivate; class OperationPrivate;
/** /**
* \class Operation Akabei/Operation * \class Operation akabeioperation.h "akabeioperation.h"
* *
* \brief Base class for all operations. * \brief Base class for all operations.
* *
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment