Help with Doxygen and Boost
Renato Forti <[email protected]> Fri, 12 Sep 2014 11:57:27 -0300
| Newsgroups | gmane.comp.lib.boost.documentation |
|---|---|
| Message-ID | <CA+xNb9s4S0NCiCiVmpmSJFP-QHguk0myJ2Kpv4Nnf2SZHFq1mA@mail.gmail.com> |
Hi All,
I have one problem in docs generation (doxygen), if anyone can help me.
I used this to hide my ‘private’ methods of docs reference :
<doxygen:param>EXTRACT_PRIVATE=NO
But this don’t work, if you check the generated docs, you will see that
docs shows the private method (check for get_impl):
http://apolukhin.github.io/Boost.DLL/boost/dll/shared_library.html#idp6341792-bb
I tried adding this too:
<doxygen:param>HIDE_UNDOC_MEMBERS=YES
<doxygen:param>HIDE_UNDOC_CLASSES=YES
<doxygen:param>HIDE_SCOPE_NAMES=YES
<doxygen:param>EXTRACT_ALL=NO
But don’t work!
This is the code that I want hide from docs:
https://github.com/apolukhin/Boost.DLL/blob/master/include/boost/dll/shared_library.hpp#L379
This is my jam for docs generation:
# ----------------------------------------------
using quickbook ;
using boostbook ;
using doxygen ;
using xsltproc ;
import set ;
import doxygen ;
import xsltproc ;
import notfile ;
import path ;
project dll/doc ;
#
# Common params for doxygen
#
local doxygen_params =
<doxygen:param>HIDE_UNDOC_MEMBERS=YES
<doxygen:param>HIDE_UNDOC_CLASSES=YES
<doxygen:param>HIDE_SCOPE_NAMES=YES
<doxygen:param>EXTRACT_ALL=NO
<doxygen:param>EXTRACT_PRIVATE=NO
<doxygen:param>BUILTIN_STL_SUPPORT=YES
<doxygen:param>ENABLE_PREPROCESSING=YES
<doxygen:param>MACRO_EXPANSION=YES
<doxygen:param>"PREDEFINED=\"BOOST_RV_REF(T)=T&&\" \\
\"BOOST_RV_REF(shared_library)=shared_library&&\" \\
\"BOOST_DLL_DOXYGEN\" "
;
#
# Ref Sessions Generation
#
doxygen autodoc_shared_library_core
:
[ glob
../../../boost/dll/shared_library.hpp
../../../boost/dll/shared_library_load_mode.hpp
../../../boost/dll/library_info.hpp
../../../boost/dll/alias.hpp
]
:
$(doxygen_params)
<xsl:param>"boost.doxygen.reftitle=Shared Library Reference"
;
doxygen autodoc_shared_library_refcountable
:
[ glob
../../../boost/dll/refcountable.hpp
]
:
$(doxygen_params)
<xsl:param>"boost.doxygen.reftitle=Shared Library Refcountable
Reference"
;
#
# Docs Generation
#
boostbook dll-doc
:
dll.qbk
:
<dependency>autodoc_shared_library_core
<dependency>autodoc_shared_library_refcountable
<xsl:param>boost.root=http://www.boost.org/doc/libs/1_56_0
#<xsl:param>boost.root=../../../.
<xml:param>html.stylesheet=../../../../doc/src/boostbook.css
;
# ----------------------------------------------
Any one have any idea, what is wrong?
Thanks for help;
_______________________________________________
Boost-docs mailing list
[email protected]
http://lists.boost.org/mailman/listinfo.cgi/boost-docs