added doxygen documentation building

sources/netctlgui/CMakeLists.txt

@@ -11,3 +11,9 @@ set (TARGETS "")
 set (HEADERS "")
 
 add_subdirectory (${SUBPROJECT_SOURCE_DIR})
+# headers
+install (DIRECTORY ${SUBPROJECT_INCLUDE_DIR}/ DESTINATION include/)
+# documentation
+if (BUILD_DOCS)
+    include (docs.cmake)
+endif ()

sources/netctlgui/docs.cmake

@@ -0,0 +1,19 @@
+# doxygen documentation
+find_package (Doxygen)
+if (NOT DOXYGEN_FOUND)
+    message (STATUS "WARNING: Doxygen not found - Reference manual will not be created")
+    return ()
+endif ()
+
+configure_file (doxygen.conf.in ${CMAKE_CURRENT_BINARY_DIR}/doxygen.conf)
+add_custom_target (oxygen-docs ALL COMMAND ${DOXYGEN_EXECUTABLE} ${CMAKE_CURRENT_BINARY_DIR}/doxygen.conf)
+
+# man pages
+# workaround for man pages
+set (MAN_DIR ${CMAKE_CURRENT_BINARY_DIR}/docs/man/man3)
+install (FILES ${MAN_DIR}/Netctl.3 DESTINATION share/man/man3 RENAME ${SUBPROJECT}_Netctl.3)
+install (FILES ${MAN_DIR}/NetctlProfile.3 DESTINATION share/man/man3 RENAME ${SUBPROJECT}_NetctlProfile.3)
+install (FILES ${MAN_DIR}/SleepThread.3 DESTINATION share/man/man3 RENAME ${SUBPROJECT}_SleepThread.3)
+install (FILES ${MAN_DIR}/WpaSup.3 DESTINATION share/man/man3 RENAME ${SUBPROJECT}_WpaSup.3)
+# html docs
+install (DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/docs/html DESTINATION share/doc/${SUBPROJECT})

sources/netctlgui/include/netctlgui/sleepthread.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 sleepthread.h
+ * Header of netctlgui library
+ * @author Evgeniy Alekseev
+ * @copyright GPLv3
+ * @bug https://github.com/arcan1s/netctl-gui/issues
+ */
+
 
 #ifndef SLEEPTHREAD_H
 #define SLEEPTHREAD_H
@@ -21,21 +29,34 @@
 #include <QThread>
 
 
+/**
+ * @brief The SleepThread class is used for sleep current thread in WpaSup class
+ */
 class SleepThread : public QThread
 {
     Q_OBJECT
 
 public:
+    /**
+     * @brief method which forces the current thread to sleep for usecs microseconds
+     * @param iSleepTime     time in microseconds
+     */
     static void usleep(long iSleepTime)
     {
         QThread::usleep(iSleepTime);
     }
-
+    /**
+     * @brief method which forces the current thread to sleep for usecs seconds
+     * @param iSleepTime     time in seconds
+     */
     static void sleep(long iSleepTime)
     {
         QThread::sleep(iSleepTime);
     }
-
+    /**
+     * @brief method which forces the current thread to sleep for usecs milliseconds
+     * @param iSleepTime     time in milliseconds
+     */
     static void msleep(long iSleepTime)
     {
         QThread::msleep(iSleepTime);

sources/netctlgui/src/CMakeLists.txt

@@ -38,4 +38,3 @@ endif()
 
 # install properties
 install (TARGETS ${SUBPROJECT} DESTINATION lib)
-install (DIRECTORY ${SUBPROJECT_INCLUDE_DIR}/ DESTINATION include/)