summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorChris Sherlock <chris.sherlock79@gmail.com>2016-01-15 06:26:41 +1100
committerChris Sherlock <chris.sherlock79@gmail.com>2016-01-15 06:26:41 +1100
commita669faa1fa88d4d82d3f1d38b652b689ecc4d3a1 (patch)
tree4a76bc24bd6b8bceee0095e25191c82933de8f3a
parent6418f58bd3550b397127f7f8f4a708276593b5a9 (diff)
vcl: allow doxygen to see boost::intrusive_ptr
We are using boost::intrusive_ptr for a number of classes, unfortunately by default we cannot see this in the Doxygen collaboration diagrams. However, we can work around this problem by making a dummy namespace which we include in a header that is scanned by Doxygen, but never included in LibreOffice. To be sure of this, however, I have put #ifdef DOXYGEN_ONLY guards around the file and defined this in the Doxygen config file. Change-Id: I18d6956518a49e6006b64e2147023ec8266c8f5c
-rw-r--r--include/vcl/doxygen_dummy.hxx8
-rw-r--r--solenv/inc/doxygen.cfg3
2 files changed, 10 insertions, 1 deletions
diff --git a/include/vcl/doxygen_dummy.hxx b/include/vcl/doxygen_dummy.hxx
new file mode 100644
index 000000000000..b10c81fdf0b2
--- /dev/null
+++ b/include/vcl/doxygen_dummy.hxx
@@ -0,0 +1,8 @@
+// Do NOT include this file anywhere! This is merely used to make Doxygen see
+// boost intrusive_ptr's - otherwise it doesn't build the collaboration diagram
+// correctly
+#ifdef DOXYGENONLY
+
+namespace boost { template<class T> class intrusive_ptr { T *ptr; }; }
+
+#endif
diff --git a/solenv/inc/doxygen.cfg b/solenv/inc/doxygen.cfg
index 4591c799906a..d2927cd81ecc 100644
--- a/solenv/inc/doxygen.cfg
+++ b/solenv/inc/doxygen.cfg
@@ -2020,7 +2020,8 @@ PREDEFINED = LINUX \
EXCEPTIONS_ON \
_GIFPRIVATE \
_XBMPRIVATE \
- _XPMPRIVATE
+ _XPMPRIVATE \
+ DOXYGEN_ONLY
# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this
# tag can be used to specify a list of macro names that should be expanded. The