[Openvas-commits] r10450 - in trunk/openvas-scanner: . doc

[scm-commit@wald.intevation.org]

Author: mwiegand
Date: 2011-03-02 11:19:06 +0100 (Wed, 02 Mar 2011)
New Revision: 10450

Added:
   trunk/openvas-scanner/doc/CMakeLists.txt
Modified:
   trunk/openvas-scanner/ChangeLog
   trunk/openvas-scanner/doc/Doxyfile.in
   trunk/openvas-scanner/doc/Doxyfile_full.in
Log:
Enable the generation of code documentation. Spotted by Michael Meyer.

  * doc/CMakeLists.txt: New. Add to enable the generation of code
  documentation.

  * doc/Doxyfile.in, doc/Doxyfile_full.in: Fix value of INPUT to match
  the current paths.


Modified: trunk/openvas-scanner/ChangeLog
===================================================================
--- trunk/openvas-scanner/ChangeLog	2011-03-01 17:04:14 UTC (rev 10449)
+++ trunk/openvas-scanner/ChangeLog	2011-03-02 10:19:06 UTC (rev 10450)
@@ -1,3 +1,13 @@
+2011-03-02  Michael Wiegand <michael.wiegand at greenbone.net>
+
+	Enable the generation of code documentation. Spotted by Michael Meyer.
+
+	* doc/CMakeLists.txt: New. Add to enable the generation of code
+	documentation.
+
+	* doc/Doxyfile.in, doc/Doxyfile_full.in: Fix value of INPUT to match
+	the current paths.
+
 2011-02-21  Michael Wiegand <michael.wiegand at greenbone.net>
 
 	Post release version bump.

Added: trunk/openvas-scanner/doc/CMakeLists.txt
===================================================================
--- trunk/openvas-scanner/doc/CMakeLists.txt	2011-03-01 17:04:14 UTC (rev 10449)
+++ trunk/openvas-scanner/doc/CMakeLists.txt	2011-03-02 10:19:06 UTC (rev 10450)
@@ -0,0 +1,62 @@
+# OpenVAS
+# $Id$
+# Description: CMakefile for the OpenVAS Scanner documentation
+#
+# Authors:
+# Matthew Mundell <matthew.mundell at greenbone.net>
+# Michael Wiegand <michael.wiegand at greenbone.net>
+#
+# Copyright:
+# Copyright (C) 2011 Greenbone Networks GmbH
+#
+# This library is free software; you can redistribute it and/or
+# modify it under the terms of the GNU Library General Public
+# License as published by the Free Software Foundation; either
+# version 2 of the License, or (at your option) any later version.
+#
+# This library is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+# Library General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
+
+## build
+
+set_directory_properties (PROPERTIES CLEAN_NO_CUSTOM true)
+set_directory_properties (PROPERTIES ADDITIONAL_MAKE_CLEAN_FILES ".built-html;.built-html_full")
+
+include (FindDoxygen)
+
+if (NOT DOXYGEN_EXECUTABLE)
+  message (STATUS "WARNING: Doxygen is required to build the HTML docs.")
+else (NOT DOXYGEN_EXECUTABLE)
+  set (DOC_FILES
+    ../src/attack.c ../src/auth.c ../src/comm.c ../src/hosts.c
+    ../src/locks.c ../src/log.c ../src/nasl_plugins.c ../src/ntp_11.c
+    ../src/openvassd.c ../src/otp_1_0.c ../src/oval_plugins.c ../src/parser.c
+    ../src/piic.c ../src/pluginlaunch.c ../src/pluginload.c
+    ../src/pluginscheduler.c ../src/plugs_hash.c ../src/plugs_req.c
+    ../src/preferences.c ../src/processes.c ../src/rules.c ../src/save_kb.c
+    ../src/shared_socket.c ../src/sighand.c ../src/users.c ../src/utils.c
+    ../README ../INSTALL)
+
+  add_custom_target (doc COMMENT "Building documentation..."
+    DEPENDS Doxyfile .built-html)
+
+  add_custom_target (doc-full COMMENT "Building documentation..."
+    DEPENDS Doxyfile_full .built-html_full)
+endif (NOT DOXYGEN_EXECUTABLE)
+
+add_custom_command (OUTPUT .built-html
+                    COMMAND sh
+					ARGS -c \"cd .. && ${DOXYGEN_EXECUTABLE} doc/Doxyfile && touch doc/.built-html\;\"
+					DEPENDS Doxyfile ${DOC_FILES})
+
+add_custom_command (OUTPUT .built-html_full
+                    COMMAND sh
+					ARGS -c \"cd .. && ${DOXYGEN_EXECUTABLE} doc/Doxyfile_full && touch doc/.built-html_full\;\"
+					DEPENDS Doxyfile_full ${DOC_FILES})
+

Modified: trunk/openvas-scanner/doc/Doxyfile.in
===================================================================
--- trunk/openvas-scanner/doc/Doxyfile.in	2011-03-01 17:04:14 UTC (rev 10449)
+++ trunk/openvas-scanner/doc/Doxyfile.in	2011-03-02 10:19:06 UTC (rev 10450)
@@ -459,7 +459,7 @@
 # directories like "/usr/src/myproject". Separate the files or directories 
 # with spaces.
 
-INPUT                  = openvassd include
+INPUT                  = src
 
 # If the value of the INPUT tag contains directories, you can use the 
 # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp 

Modified: trunk/openvas-scanner/doc/Doxyfile_full.in
===================================================================
--- trunk/openvas-scanner/doc/Doxyfile_full.in	2011-03-01 17:04:14 UTC (rev 10449)
+++ trunk/openvas-scanner/doc/Doxyfile_full.in	2011-03-02 10:19:06 UTC (rev 10450)
@@ -459,7 +459,7 @@
 # directories like "/usr/src/myproject". Separate the files or directories 
 # with spaces.
 
-INPUT                  = openvassd include
+INPUT                  = src
 
 # If the value of the INPUT tag contains directories, you can use the 
 # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp