Permalink
Browse files

documented parameters

  • Loading branch information...
saurabhsood91 committed Aug 17, 2012
1 parent afde48f commit b4d8add31108177082b3f134025456e4cf03c02e
View
@@ -45,7 +45,9 @@ class Backend : public PackageBackend
protected:
/**
- Check if repo exists in the Repository database or not
+ * @brief returns true if repository exists in database
+ * @param repo : the url of the repository
+ * @return
*/
bool exists( std::string repo );
View
@@ -14,7 +14,8 @@ class FakeBackend : public PackageBackend
{
public:
/**
- Default Constructor
+ * @brief FakeBackend
+ * @param main : main widget pointer
*/
FakeBackend( QWidget* main );
View
@@ -30,14 +30,20 @@ class FirstScreen : public QWidget
{
Q_OBJECT
public:
- /**
- Default constructor taking the backend, and the filename as argument
- */
+
+ /**
+ * @brief FirstScreen
+ * @param backend : backend pointer
+ * @param tmpFileName : temporary filename
+ * @param filename : ymp filename
+ * @param parent
+ */
FirstScreen( PackageBackend *backend, QString *tmpFileName, const QString& filename, QObject *parent = 0 );
private slots:
/**
- Show Event
+ * @brief showEvent
+ * @param s
*/
void showEvent( QShowEvent * s);
View
@@ -21,13 +21,17 @@ class InstallScreen : public QWidget
public:
/**
- * Default Constructor
+ * @brief InstallScreen
+ * @param backend : backend pointer
+ * @param tmpFileName : temporary filename
+ * @param parent
*/
InstallScreen( PackageBackend *backend, QString *tmpFileName, QObject *parent = 0 );
protected:
/**
- * Default Show Event. To start the timer
+ * @brief showEvent
+ * @param s
*/
void showEvent( QShowEvent *s );
View
@@ -19,14 +19,17 @@ class MainHeader : public QWidget
MainHeader( QWidget *parent = 0 );
/**
- * Update the size of the packages
+ * @brief updateDetails : update package size
+ * @param size : size of package
*/
void updateDetails( QString size );
public slots:
/**
- * Recieve the Repository and Package Counts, and set them in the respective labels
+ * @brief changeStatusLabel : update repo and package counts
+ * @param repoCount : repository count
+ * @param packageCount : package counts
*/
void changeStatusLabel( int repoCount, int packageCount );
View
@@ -23,8 +23,12 @@ class MainWindow : public QDialog
Q_OBJECT
public:
/**
- Default Constructor taking the YMP file as argument
- */
+ * @brief MainWindow
+ * @param filename : ymp filename
+ * @param tmpFileName : temporary filename
+ * @param fakeRequested : if fake backend requested
+ * @param parent
+ */
MainWindow( const QString& filename, QString tmpFileName, bool fakeRequested, QObject *parent = 0 );
private:
@@ -52,7 +56,9 @@ private slots:
void showNextScreen( int index );
/**
- * Update the Repository and Package Counts
+ * @brief updateCount : update repo and package counts
+ * @param repoCount : repository count
+ * @param packageCount : package count
*/
void updateCount(int repoCount , int packageCount);
@@ -67,7 +73,8 @@ private slots:
void showSettings();
/**
- * Update the size of packages
+ * @brief updateSize : update size
+ * @param size : size of package
*/
void updateSize(QString size );
View
@@ -29,18 +29,21 @@ class Package
QString description() const;
/**
- Sets the name for the package
- */
+ * @brief setName : set name of package
+ * @param name : package name
+ */
void setName( const QString& name );
/**
- Sets the summary for the package
- */
+ * @brief setSummary : set package summary
+ * @param summary : package summary
+ */
void setSummary( const QString& summary );
/**
- Sets the description for the package
- */
+ * @brief setDescription : set package description
+ * @param description : package description
+ */
void setDescription( const QString& description );
private:
QString m_name;
View
@@ -8,12 +8,14 @@ class PackageBackend
{
public:
/**
- Adds the repository required to install the selected packages. This will be added to the system as installation and update repository
+ * @brief addRepository : add repository to repo list
+ * @param url : url of repository
*/
virtual void addRepository( const QUrl& url );
/**
- Add the package to be installed
+ * @brief addPackage : adds package to package list
+ * @param package : name of package
*/
virtual void addPackage( const QString& package);
@@ -43,7 +45,8 @@ class PackageBackend
virtual void callBackendHelper() = 0;
/**
- Set the Temporary Filename
+ * @brief setFileName : set temporary filename
+ * @param fileName : temporary filename
*/
virtual void setFileName( QString fileName );
View
@@ -16,7 +16,10 @@ class PackageDetails : public QWidget
public:
/**
- * Constructor for Package Widget. Parameter is the index and Package Object
+ * @brief PackageDetails
+ * @param package : Package object
+ * @param count : package index
+ * @param parent
*/
PackageDetails( OCI::Package *package, int count, QObject *parent = 0 );
private:
@@ -34,12 +37,15 @@ class PackageDetails : public QWidget
private slots:
/**
- * Show the Package Description Label
+ * @brief showPackageDescription : show/hide description
+ * @param link : link no
*/
void showPackageDescription( QString link );
/**
- * Update the version and size of the package
+ * @brief dataChanged : update version and size
+ * @param version : package version
+ * @param size : package size
*/
void dataChanged( QString version, QString size );
View
@@ -12,7 +12,8 @@ class PackageMetadata : public QObject
public:
/**
- * Construct the Object using the name of the package
+ * @brief PackageMetadata
+ * @param name : package name
*/
PackageMetadata( QString name );
View
@@ -39,28 +39,33 @@ class Repository
QString recommended() const;
/**
- Sets the value of Recommended for the repository
- */
+ * @brief setRecommended : set recommended value
+ * @param recommmended : recommended value
+ */
void setRecommended( const QString& recommmended );
/**
- Sets the name for the repository
- */
+ * @brief setName : set name of repo
+ * @param name : name of repo
+ */
void setName( const QString& name );
/**
- Sets the description for the repository
- */
+ * @brief setDescription : set repo description
+ * @param description : repo description
+ */
void setDescription( const QString& description );
/**
- Sets the summary for the repository
- */
+ * @brief setSummary : set repo summary
+ * @param summary : repo summary
+ */
void setSummary( const QString& summary );
/**
- Set the URL for the repository
- */
+ * @brief setUrl : set repo url
+ * @param url : repo url
+ */
void setUrl( const QString& url );
private:
QString m_recommended;
View
@@ -23,12 +23,14 @@ class RepositoryData
RepositoryData();
/**
- * Set Base Url of Repository
+ * @brief setBaseUrl : set repo base url
+ * @param url : repo url
*/
void setBaseUrl( std::string url );
/**
- * Set Alias of Repository
+ * @brief setAlias : set repo alias
+ * @param alias : repo alias
*/
void setAlias( std::string alias );
View
@@ -12,7 +12,8 @@ class RepositoryMetadata
public:
/**
- * Construct the Object with Repository Object
+ * @brief RepositoryMetadata
+ * @param repository : Repository object
*/
RepositoryMetadata( OCI::Repository *repository );
View
@@ -16,14 +16,19 @@ class RepositoryWidget : public QWidget
public:
/**
- * Construct widget with index, Repository Object and Backend object
+ * @brief RepositoryWidget
+ * @param backend : backend pointer
+ * @param index : repository index
+ * @param repo : Repository object
+ * @param parent
*/
RepositoryWidget(PackageBackend *backend, int index, OCI::Repository *repo, QObject *parent = 0 );
private slots:
/**
- * Show Repository Details
+ * @brief showDetails : show repository details
+ * @param link : link no
*/
void showDetails( QString link );
View
@@ -14,8 +14,10 @@ class Settings : public QDialog
public:
/**
- Constructor for the Settings dialog
- */
+ * @brief Settings
+ * @param settings : QSettings object
+ * @param parent
+ */
Settings(QSettings *settings, QObject *parent = 0 );
private:
View
@@ -19,7 +19,10 @@ class Summary : public QWidget
public:
/**
- * Construct the object with the filename and backend object
+ * @brief Summary
+ * @param backend : backend pointer
+ * @param tmpFileName : temporary filename
+ * @param parent
*/
Summary( PackageBackend *backend, QString *tmpFileName, QObject *parent = 0 );
View
@@ -12,8 +12,9 @@ class YmpParser
{
public:
/**
- Default Constructor
- */
+ * @brief YmpParser
+ * @param ympfile : ymp filename
+ */
YmpParser( const QString& ympfile );
/**

1 comment on commit b4d8add

Owner

cornelius commented on b4d8add Aug 18, 2012

This documentation is still mostly pointless, as it just repeats what is obvious from looking at the function definitions. Please don't waste your time on something like this. If you want to have a look at an example of API documentation, which makes sense, check out the Qt documentation.

Please sign in to comment.