arcanis/netctl-gui
1
0
Fork 0
mirror of https://github.com/arcan1s/netctl-gui.git synced 2025-07-07 19:05:52 +00:00
Code Issues Projects Releases Wiki Activity

add documentation to netctlprofile

Browse Source
This commit is contained in:
arcan1s
2014-07-15 13:32:22 +04:00
parent 05f9759d47
commit bc8655aaeb
3 changed files with 98 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
sources/netctlgui/src/main.cpp
View File

@ -14,6 +14,13 @@
* You should have received a copy of the GNU General Public License *
* along with netctl-gui. If not, see http://www.gnu.org/licenses/ *
***************************************************************************/
/**
* @file main.cpp
* Source code of netctlgui library
* @author Evgeniy Alekseev
* @copyright GPLv3
* @bug https://github.com/arcan1s/netctl-gui/issues
*/
#include <netctlgui/netctlinteract.h>
@ -22,7 +29,13 @@
#include <netctlgui/wpasupinteract.h>
/**
* @fn main
*/
int main(int argc, char *argv[])
/**
* @return 0 - exit without errors
*/
{
return 0;
}

32
sources/netctlgui/src/netctlprofile.cpp
View File

@ -14,6 +14,13 @@
* You should have received a copy of the GNU General Public License *
* along with netctl-gui. If not, see http://www.gnu.org/licenses/ *
***************************************************************************/
/**
* @file netctlprofile.cpp
* Source code of netctlgui library
* @author Evgeniy Alekseev
* @copyright GPLv3
* @bug https://github.com/arcan1s/netctl-gui/issues
*/
#include <QDebug>
@ -25,16 +32,29 @@
#include <netctlgui/netctlprofile.h>
/**
* @class NetctlProfile
*/
/**
* @fn NetctlProfile
*/
NetctlProfile::NetctlProfile(const bool debugCmd, const QMap<QString, QString> settings)
: debug(debugCmd)
{
if (settings.contains(QString("PROFILE_DIR")))
profileDirectory = new QDir(settings[QString("PROFILE_DIR")]);
else
profileDirectory = new QDir(QString("/etc/netctl/"));
if (settings.contains(QString("SUDO_PATH")))
sudoCommand = settings[QString("SUDO_PATH")];
else
sudoCommand = QString("/usr/bin/kdesu");
}
/**
* @fn ~NetctlProfile
*/
NetctlProfile::~NetctlProfile()
{
if (debug) qDebug() << "[NetctlProfile]" << "[~NetctlProfile]";
@ -44,6 +64,9 @@ NetctlProfile::~NetctlProfile()
}
/**
* @fn copyProfile
*/
bool NetctlProfile::copyProfile(const QString oldPath)
{
if (debug) qDebug() << "[NetctlProfile]" << "[copyProfile]";
@ -71,6 +94,9 @@ bool NetctlProfile::copyProfile(const QString oldPath)
}
/**
* @fn createProfile
*/
QString NetctlProfile::createProfile(const QString profile, const QMap<QString, QString> settings)
{
if (debug) qDebug() << "[NetctlProfile]" << "[createProfile]";
@ -106,6 +132,9 @@ QString NetctlProfile::createProfile(const QString profile, const QMap<QString,
}
/**
* @fn getSettingsFromProfile
*/
QMap<QString, QString> NetctlProfile::getSettingsFromProfile(const QString profile)
{
if (debug) qDebug() << "[NetctlProfile]" << "[getSettingsFromProfile]";
@ -157,6 +186,9 @@ QMap<QString, QString> NetctlProfile::getSettingsFromProfile(const QString profi
}
/**
* @fn removeProfile
*/
bool NetctlProfile::removeProfile(const QString profile)
{
if (debug) qDebug() << "[NetctlProfile]" << "[removeProfile]";