-----Original Message----- From: boost-bounces@lists.boost.org [mailto:boost-bounces@lists.boost.org] On Behalf Of Kim Barrett Sent: Wednesday, September 16, 2009 4:20 PM To: boost@lists.boost.org Subject: Re: [boost] doxygen doc / STL container unit test
At 5:48 PM +0200 9/16/09, Stefan Strasser wrote:
the parameters in the jamfile do end up in the doxygen configuration file, but it seems that doxygen ignores a lot of parameters for its XML output, like hide undoc members. which makes sense, because a XML processor can take care of that. but it doesn't, so two libraries I've looked at encapsulate all private declarations in /// @cond ... /// @endcond tags.
In case this hasn't already been checked, is doxygen's EXTRACT_PRIVATE parameter set to NO?
I believe so: (but I haven't tried fiddling with other settings yet). Suggestions? Paul doxygen autodoc : [ glob ../../../boost/svg_plot/*.hpp ] [ glob ../../../boost/svg_plot/detail/*.hpp ] : #<doxygen:param>INPUT="filename1 directoryname2" # Separate with spaces. # But also see paths specified above. <doxygen:param>RECURSIVE=YES # Search subdirectories as well. <doxygen:param>STRIP_FROM_PATH=I:/ # Strip this from full path name. <doxygen:param>TAB_SIZE=2 # <doxygen:param>EXTRACT_ALL=YES # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in # documentation are documented, even if no documentation was available. # Private class members and static file members will be hidden unless # the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES <doxygen:param>HIDE_UNDOC_MEMBERS=NO <doxygen:param>INLINE_INHERITED_MEMB=YES # Show all inherited members of a class in the documentation of that class as if those members were ordinary class members. <doxygen:param>SORT_MEMBER_DOCS=YES <doxygen:param>EXTRACT_STATIC=YES # If the EXTRACT_STATIC tag is set to YES all static members of a file # will be included in the documentation. <doxygen:param>EXTRACT_PRIVATE=NO # If the EXTRACT_PRIVATE tag is set to YES all private members of a class will be included in the documentation # If the EXTRACT_STATIC tag is set to YES all static members of a file # will be included in the documentation. # <doxygen:param>EXTRACT_LOCAL_STATIC=YES # ? Not supported. <doxygen:param>EXTRACT_LOCAL_METHODS=YES # Only useful for Objective C? <doxygen:param>EXTRACT_LOCAL_CLASSES=YES # If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) # defined locally in source files will be included in the documentation. # If set to NO only classes defined in header files are included. <doxygen:param>ENABLE_PREPROCESSING=YES # Doxygen will expand all macro names in the source code. <doxygen:param>MACRO_EXPANSION=YES # If the MACRO_EXPANSION tag is set to YES all macro # Doxygen will expand all names in the source code. <doxygen:param>EXPAND_ONLY_PREDEF=NO # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES # then the macro expansion is limited to the macros specified with the # PREDEFINED and EXPAND_AS_DEFINED tags. <doxygen:param>SEARCH_INCLUDES=YES # If the SEARCH_INCLUDES tag is set to YES (the default) the includes files in the INCLUDE_PATH. <doxygen:param>INLINE_INFO=YES # If the INLINE_INFO tag is set to YES (the default) then a tag [inline] is inserted in the documentation for inline members. <doxygen:param>SORT_BRIEF_DOCS=YES # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief descriptions of file, namespace and class members alphabetically by member name. <doxygen:param>SORT_MEMBER_DOCS=YES # If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen will sort the (detailed) documentation of file and class members alphabetically by member name. <doxygen:param>SHOW_INCLUDE_FILES=YES # List of the files that are included by a file in the documentation of that file. <doxygen:param>REPEAT_BRIEF=YES # Prepend the brief description of a member or function before the detailed description <doxygen:param>BRIEF_MEMBER_DESC=YES # Include brief member descriptions after the members that are listed in the file and class <doxygen:param>MULTILINE_CPP_IS_BRIEF=YES # Treat a multi-line C++ special comment block (i.e. a block of //! or /// comments) as a brief description. # May be best to always use \brief and \details to avoid ambiguity? <doxygen:param>INCLUDE_PATH=$(BOOST_ROOT) # The INCLUDE_PATH tag can be used to specify one or more directories that # contain include files that are not input files but should be processed by the preprocessor. <doxygen:param>WARNINGS=YES # If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings for undocumented members. # If EXTRACT_ALL is set to YES then this flag will automatically be disabled. <doxygen:param>WARN_IF_UNDOCUMENTED=YES # If WARN_IF_UNDOCUMENTED is set to YES, # then doxygen will generate warnings for undocumented members. <doxygen:param>WARN_IF_DOC_ERROR=YES # If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for # potential errors in the documentation. <doxygen:param>WARN_LOGFILE=../../../libs/svg_plot/doc/doxywarnings.log # Specific log file - ideally this should be empty! <doxygen:param>EXCLUDE="../../../boost/svg_plot/svg_fwd.hpp ../../../boost/svg_plot/stylesheet.hpp" # Exclude to avoid warnings about file(s) undocumented. # Note: no commas required but need quotes if more than one file. ; #<doxygen:param>"PREDEFINED=\"BOOST_DEDUCED_TYPENAME=typename\" " # See Doxygen configuration for detailed explanation of these options