From 503ba93a4ebf316ab01b468808e4cda2da8b863e Mon Sep 17 00:00:00 2001 From: David Robillard Date: Thu, 26 Nov 2020 16:07:41 +0100 Subject: Generate documentation with Sphinx --- doc/cpp/Doxyfile | 40 ++++++++++++++++++++++++++++++++++++++++ 1 file changed, 40 insertions(+) create mode 100644 doc/cpp/Doxyfile (limited to 'doc/cpp/Doxyfile') diff --git a/doc/cpp/Doxyfile b/doc/cpp/Doxyfile new file mode 100644 index 0000000..2bb0f9f --- /dev/null +++ b/doc/cpp/Doxyfile @@ -0,0 +1,40 @@ +PROJECT_NAME = Pugl +PROJECT_BRIEF = "A minimal portable API for embeddable GUIs" + +QUIET = YES +WARN_AS_ERROR = NO +WARN_IF_UNDOCUMENTED = NO +WARN_NO_PARAMDOC = NO + +JAVADOC_AUTOBRIEF = YES + +CASE_SENSE_NAMES = YES +EXCLUDE_SYMBOLS = pugl::detail +EXTRACT_LOCAL_CLASSES = NO +EXTRACT_PRIVATE = NO +HIDE_IN_BODY_DOCS = YES +HIDE_UNDOC_CLASSES = YES +HIDE_UNDOC_MEMBERS = YES +REFERENCES_LINK_SOURCE = NO + +GENERATE_HTML = NO +GENERATE_LATEX = NO +GENERATE_XML = YES +XML_PROGRAMLISTING = NO +SHOW_FILES = NO + +MACRO_EXPANSION = YES +PREDEFINED = PUGL_API PUGL_DISABLE_DEPRECATED PUGL_CONST_FUNC= + +INPUT = ../../include/pugl/cairo.h \ + ../../include/pugl/gl.h \ + ../../include/pugl/pugl.h \ + ../../include/pugl/stub.h \ + ../../include/pugl/vulkan.h \ + ../../bindings/cxx/include/pugl/cairo.hpp \ + ../../bindings/cxx/include/pugl/gl.hpp \ + ../../bindings/cxx/include/pugl/pugl.hpp \ + ../../bindings/cxx/include/pugl/stub.hpp \ + ../../bindings/cxx/include/pugl/vulkan.hpp + +OUTPUT_DIRECTORY = . -- cgit v1.2.1