[Doxygen-users] Documenting entities in empty namspace
Brought to you by:
dimitri
From: Brad B. <bra...@se...> - 2014-02-27 15:00:12
|
How does one include doxygen documentation for entities in the empty namespace ? For example, if you execute the bash script below, the documentation for function_in_empty_namespace is missing: ---------------- #! /bin/bash -e cat << EOF This script creates a C++ source file called build/empty_namespace.cpp and corresponding html documentation in build/html/files.html If you view the source file and the html documentation, you will see that the html documentation for the function in the empty namespace is missing. EOF cat << EOF > build/empty_namespace.cpp /// @file empty_namespace.cpp /// @brief Doxygen example showing that empty namespace functions are missing namespace { /// A documented function in the empty namespace int function_in_empty_namespace(void) { return 1; } } /// A documented function not in empty namespace void function_outside_empty_namespace(void) { std::cout << function_in_empty_namespace(void) << std::endl; } EOF echo if [ ! -e build ] then mkdir build fi echo 'cd build' cd build echo "doxygen -g doxyfile > doxyfile.log" doxygen -g doxyfile > doxyfile.log # echo "sed -e 's|\(^INPUT *\)=.*|\1= empty_namespace.cpp|' -i doxyfile" sed -e 's|\(^INPUT *\)=.*|\1= empty_namespace.cpp|' -i doxyfile # echo "sed -e 's|\(^SOURCE_BROWSER *\)=.*|\1= YES|' -i doxyfile" sed -e 's|\(^SOURCE_BROWSER *\)=.*|\1= YES|' -i doxyfile sed -e 's|\(^STRIP_CODE_COMMENTS *\)=.*|\1= NO|' -i doxyfile # echo "doxygen doxyfile > doxygen.log" doxygen doxyfile > doxygen.log |