Changeset 48994 in vbox for trunk/src/VBox/Frontends/VirtualBox

Timestamp:

Oct 9, 2013 11:13:11 AM (11 years ago)

Author:

vboxsync

Message:

GUI doxygen.

Location:

trunk/src/VBox/Frontends/VirtualBox

Files:

• Doxyfile (copied) (copied from trunk/src/VBox/Runtime/Doxyfile ) (8 diffs)
• Makefile.kmk (modified) (1 diff)

trunk/src/VBox/Frontends/VirtualBox/Doxyfile

@@ -26 +26 @@
 # by quotes) that should identify the project.
 
-PROJECT_NAME           = IPRT
+PROJECT_NAME           = VirtualBox Qt GUI
 
 # The PROJECT_NUMBER tag can be used to enter a project or revision number.
@@ -100 +100 @@
 # operators of the base classes will not be shown.
 
-INLINE_INHERITED_MEMB  = NO
+INLINE_INHERITED_MEMB  = YES
 
 # If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
@@ -211 +211 @@
 # of all members will be omitted, etc.
 
-OPTIMIZE_OUTPUT_FOR_C  = YES
+OPTIMIZE_OUTPUT_FOR_C  = NO
 
 # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java
@@ -284 +284 @@
 # types are typedef'ed and only the typedef is referenced, never the tag name.
 
-TYPEDEF_HIDES_STRUCT   = NO
+TYPEDEF_HIDES_STRUCT   = YES
 
 #---------------------------------------------------------------------------
@@ -468 +468 @@
 # in the documentation. The default is NO.
 
-SHOW_DIRECTORIES       = NO
+SHOW_DIRECTORIES       = YES
 
 # Set the SHOW_FILES tag to NO to disable the generation of the Files page.
@@ -577 +577 @@
 # If left blank NO is used.
 
-RECURSIVE              = NO
+RECURSIVE              = YES
 
 # The EXCLUDE tag can be used to specify files and/or directories that should
@@ -822 +822 @@
 # Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari).
 
-HTML_DYNAMIC_SECTIONS  = NO
+HTML_DYNAMIC_SECTIONS  = YES
 
 # If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
@@ -865 +865 @@
 # the value YES disables it.
 
-DISABLE_INDEX          = YES
+DISABLE_INDEX          = NO
 
 # This tag can be used to set the number of enum values (range [1..20])

trunk/src/VBox/Frontends/VirtualBox/Makefile.kmk

@@ -1090 +1090 @@
 
 
+#
+# Doxygen documentation.
+#
+QTGUI_DOXYFILE_OUTPUT = $(PATH_OUT)/docs/qtgui
+BLDDIRS += $(QTGUI_DOXYFILE_OUTPUT)
+OTHER_CLEAN += \
+        $(QTGUI_DOXYFILE_OUTPUT)/Doxyfile.qtgui \
+        $(QTGUI_DOXYFILE_OUTPUT)/docs.qtgui
+
+# Generate the Doxyfile
+$(QTGUI_DOXYFILE_OUTPUT)/Doxyfile.qtgui: \
+                $(PATH_CURRENT)/Doxyfile \
+                $(PATH_CURRENT)/Makefile.kmk \
+                | $$(dir $$@)
+        $(RM) -f $@ [email protected] [email protected]
+        $(CP) -f $< [email protected]
+        $(APPEND) [email protected]
+        $(APPEND) [email protected] "OUTPUT_DIRECTORY = $(QTGUI_DOXYFILE_OUTPUT)"
+        $(APPEND) [email protected] "WARN_LOGFILE = $(QTGUI_DOXYFILE_OUTPUT)/errors"
+        $(APPEND) [email protected] "INCLUDE_PATH = $(PATH_ROOT)/include ."
+        $(APPEND) [email protected] "PREDEFINED += $(ARCH_BITS_DEFS)"
+        $(APPEND) [email protected]
+        $(APPEND) [email protected] "INPUT = $(dir $<)"
+        $(APPEND) [email protected]
+        $(MV) -f [email protected] $@
+
+# Do the actual job.
+$(QTGUI_DOXYFILE_OUTPUT)/docs.qtgui: $(QTGUI_DOXYFILE_OUTPUT)/Doxyfile.qtgui $$(QTGUI_DOXYFILE_INPUT) | $(QTGUI_DOXYFILE_OUTPUT)/
+        $(RM) -f $(wildcard $(QTGUI_DOXYFILE_OUTPUT)/html/*) $(QTGUI_DOXYFILE_OUTPUT)/docs.qtgui
+        doxygen $(QTGUI_DOXYFILE_OUTPUT)/Doxyfile.qtgui
+        $(APPEND) $(QTGUI_DOXYFILE_OUTPUT)/docs.qtgui
+
+# aliases
+docs.qtgui: $(QTGUI_DOXYFILE_OUTPUT)/docs.qtgui
+if !defined(VBOX_ONLY_DOCS) && defined(VBOX_WITH_ALL_DOXYGEN_TARGETS)
+docs:      $(QTGUI_DOXYFILE_OUTPUT)/docs.qtgui
+endif
+
+
+
 # Commit the magic.
 # (note: before custom rules that make usage of generated variables!).