[PATCH] Qt Creator help/documentation file for LLVM

Michael Gottesman mgottesman at apple.com
Wed Mar 5 09:54:25 PST 2014

  Please see the comments above.

Comment at: docs/CMakeLists.txt:60
@@ -27,3 +59,3 @@
You should undefine the cmake variables you are defining for use in doxygen here like the rest of the cmake variables used to configure the doxygen file.

Comment at: docs/CMakeLists.txt:28
@@ +27,3 @@
+  #-----------------------------------------------
+    "Generate a Qt Compressed Help file." OFF)
Could you change this variable name to LLVM_ENABLE_DOXYGEN_QT_HELP.

Comment at: docs/CMakeLists.txt:39
@@ +38,3 @@
+      "See http://qt-project.org/doc/qt-4.8/qthelpproject.html#filter-attributes")
+    find_program(LLVM_DOXYGEN_QHELPGENERATOR_PATH qhelpgenerator 
+      DOC "Path to the qhelpgenerator binary")
You should check if we successfully find the program and error via message(FATAL_ERROR ...). If they asked us to generate this and we can't find the program it seems to me that that should be a hard error.

Comment at: docs/CMake.rst:290
@@ +289,3 @@
+  Enables the generation of a Qt Compressed Help file. Defaults to OFF.
Make sure to update this with respect to my comments below.

Comment at: docs/CMakeLists.txt:26
@@ +25,3 @@
+  #-----------------------------------------------
+  # This lets you create a Qt Compressed Help file
+  #-----------------------------------------------
I don't think we are doing banner comments in CMake. Double check there is precedent for this. If there is ok, but if not just get rid of the banner. Something like this would be good:

# If asked, configure doxygen for the creation of a Qt Compressed Help file.




More information about the llvm-commits mailing list