From bc8655aaeb0ce6c3bb93be88a0e050abf8978c81 Mon Sep 17 00:00:00 2001 From: arcan1s Date: Tue, 15 Jul 2014 13:32:22 +0400 Subject: [PATCH] add documentation to netctlprofile --- .../include/netctlgui/netctlprofile.h | 53 +++++++++++++++++++ sources/netctlgui/src/main.cpp | 13 +++++ sources/netctlgui/src/netctlprofile.cpp | 32 +++++++++++ 3 files changed, 98 insertions(+) diff --git a/sources/netctlgui/include/netctlgui/netctlprofile.h b/sources/netctlgui/include/netctlgui/netctlprofile.h index e3fd81b..fbbb44d 100644 --- a/sources/netctlgui/include/netctlgui/netctlprofile.h +++ b/sources/netctlgui/include/netctlgui/netctlprofile.h @@ -14,6 +14,14 @@ * 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.h + * Header of netctlgui library + * @author Evgeniy Alekseev + * @copyright GPLv3 + * @bug https://github.com/arcan1s/netctl-gui/issues + */ + #ifndef NETCTLPROFILE_H #define NETCTLPROFILE_H @@ -23,22 +31,67 @@ #include +/** + * @brief The NetctlProfile class interacts with netctl profiles + */ class NetctlProfile : public QObject { Q_OBJECT public: + /** + * @brief NetctlProfile class constructor + * @param debugCmd show debug messages + * @param settings default settings. Needed keys are + * PROFILE_DIR (path to directory which contains profiles), + * SUDO_PATH (path to sudo command) + */ explicit NetctlProfile(const bool debugCmd = false, const QMap settings = QMap()); + /** + * @brief Netctl class destructor + */ ~NetctlProfile(); + /** + * @brief function which copies temporary profile to PROFILE_DIR + * @param oldPath path to temprorary profile + * @return false if components are not found or command exit code is not equal to 0 + * @return true if the function was completed without errors + */ bool copyProfile(const QString oldPath); + /** + * @brief function which creates temporary profile + * @param profile profile name + * @param settings profile configuration. All available keys will be printed to the profile + * @return temporary profile name + */ QString createProfile(const QString profile, const QMap settings); + /** + * @brief function which reads settings from profile + * @param profile profile name + * @return settings from profile + */ QMap getSettingsFromProfile(const QString profile); + /** + * @brief function which removes profile + * @param profile profile name + * @return false if components are not found or command exit code is not equal to 0 + * @return true if the function was completed without errors + */ bool removeProfile(const QString profile); private: + /** + * @brief show debug messages + */ bool debug; + /** + * @brief path to directory which contains profiles. Defaults is /etc/netctl + */ QDir *profileDirectory; + /** + * @brief path to sudo command. Defaults is /usr/bin/kdesu + */ QString sudoCommand; }; diff --git a/sources/netctlgui/src/main.cpp b/sources/netctlgui/src/main.cpp index 2075724..30507ef 100644 --- a/sources/netctlgui/src/main.cpp +++ b/sources/netctlgui/src/main.cpp @@ -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 @@ -22,7 +29,13 @@ #include +/** + * @fn main + */ int main(int argc, char *argv[]) +/** + * @return 0 - exit without errors + */ { return 0; } diff --git a/sources/netctlgui/src/netctlprofile.cpp b/sources/netctlgui/src/netctlprofile.cpp index bebe2c4..f4380df 100644 --- a/sources/netctlgui/src/netctlprofile.cpp +++ b/sources/netctlgui/src/netctlprofile.cpp @@ -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 @@ -25,16 +32,29 @@ #include +/** + * @class NetctlProfile + */ +/** + * @fn NetctlProfile + */ NetctlProfile::NetctlProfile(const bool debugCmd, const QMap 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 settings) { if (debug) qDebug() << "[NetctlProfile]" << "[createProfile]"; @@ -106,6 +132,9 @@ QString NetctlProfile::createProfile(const QString profile, const QMap NetctlProfile::getSettingsFromProfile(const QString profile) { if (debug) qDebug() << "[NetctlProfile]" << "[getSettingsFromProfile]"; @@ -157,6 +186,9 @@ QMap NetctlProfile::getSettingsFromProfile(const QString profi } +/** + * @fn removeProfile + */ bool NetctlProfile::removeProfile(const QString profile) { if (debug) qDebug() << "[NetctlProfile]" << "[removeProfile]";