build/doc: remove Doxyfile as doxygen run via make

also update document doxygen behavior
this is to complete: https://github.com/ceph/ceph/pull/35027

Signed-off-by: Yuval Lifshitz <ylifshit@redhat.com>

diff --git a/Doxyfile b/Doxyfile
deleted file mode 100644 (file)
index 4ec2464..0000000
--- a/Doxyfile
+++ /dev/null
@@ -1,23 +0,0 @@
-PROJECT_NAME = Ceph
-OUTPUT_DIRECTORY = build-doc/doxygen
-STRIP_FROM_PATH = src/
-STRIP_FROM_INC_PATH = src/include
-BUILTIN_STL_SUPPORT = YES
-SYMBOL_CACHE_SIZE = 2
-WARN_IF_UNDOCUMENTED = NO
-INPUT = src
-RECURSIVE = YES
-EXCLUDE = src/googletest \
-       src/test/virtualenv \
-       src/out \
-       src/tracing \
-       src/civetweb
-
-VERBATIM_HEADERS = NO
-GENERATE_HTML = NO
-GENERATE_LATEX = NO
-GENERATE_XML = YES
-XML_PROGRAMLISTING = NO
-HAVE_DOT = YES
-DOT_TRANSPARENT = YES
-JAVADOC_AUTOBRIEF = YES

diff --git a/doc/dev/documenting.rst b/doc/dev/documenting.rst
index 01984c2561da148bd65dff3d04badc5255bd7342..42bd56d06fed5754d55090445efaf1c1d5d810d1 100644 (file)
--- a/doc/dev/documenting.rst
+++ b/doc/dev/documenting.rst
@@ -51,6 +51,14 @@ functions should be grouped into logical categories. The `librados C
 API`_ provides a complete example. It is pulled into Sphinx by
 `librados.rst`_, which is rendered at :doc:`/rados/api/librados`.
 
+To generate the doxygen documentation in HTML format use:
+
+::
+
+   # make doxygen
+
+HTML output will be under: ``build-doc/doxygen/html`` 
+
 .. _`librados C API`: https://github.com/ceph/ceph/blob/master/src/include/rados/librados.h
 .. _`librados.rst`: https://github.com/ceph/ceph/raw/master/doc/rados/api/librados.rst
 

diff --git a/src/CMakeLists.txt b/src/CMakeLists.txt
index 7a86043e5fbe2674c1e3519a59b16396e300c806..75cba9393ef3c0b3237b5c326f3b528dc29518c9 100644 (file)
--- a/src/CMakeLists.txt
+++ b/src/CMakeLists.txt
@@ -893,12 +893,22 @@ if(DOXYGEN_FOUND)
   set(DOXYGEN_FILE_PATTERNS *.cc *.c *.cpp *.C *.cxx *.c++ *.CC *.H *.h *.hh *.hpp)
   set(DOXYGEN_SOURCE_BROWSER YES)
   set(DOXYGEN_WARN_IF_UNDOCUMENTED NO)
-  set(DOXYGEN_CLANG_ASSISTED_PARSING YES)
-  set(DOXYGEN_CLANG_DATABASE_PATH .)
+  # enabling clang slows down doxygen significantly
+  set(DOXYGEN_CLANG_ASSISTED_PARSING NO)
+  set(DOXYGEN_CLANG_DATABASE_PATH "${PROJECT_BINARY_DIR}")
   set(DOXYGEN_BUILTIN_STL_SUPPORT YES)
   set(DOXYGEN_RECURSIVE YES)
   set(DOXYGEN_QUIET YES)
   set(DOXYGEN_GENERATE_LATEX NO)
+  set(DOXYGEN_GENERATE_XML NO)
+  set(DOXYGEN_GENERATE_HTML YES)
+  set(DOXYGEN_PROJECT_NAME Ceph)
+  set(DOXYGEN_OUTPUT_DIRECTORY "${PROJECT_SOURCE_DIR}/build-doc/doxygen")
+  set(DOXYGEN_STRIP_FROM_PATH "src/")
+  set(DOXYGEN_STRIP_FROM_INC_PATH "src/include")
+  set(DOXYGEN_JAVADOC_AUTOBRIEF YES)
+  set(DOXYGEN_HAVE_DOT NO)
+  set(DOXYGEN_VERBATIM_HEADERS YES)
   doxygen_add_docs(doxygen
     auth
     client
@@ -919,7 +929,6 @@ if(DOXYGEN_FOUND)
     libradosstriper
     librbd
     log
-    lua
     mds
     messages
     mgr