Add documentation to hpx::util::unwrapped and hpx::util::unwrapped2. #2660
Conversation
| } | ||
|
|
||
| /////////////////////////////////////////////////////////////////////////// | ||
| } // end namespace detail |
There was a problem hiding this comment.
All of the namespace detail should be wrapped in a pair of /// \cond NOINTERNAL//// \endcond, please see the parallel algorithms for example. This ahides all the implementation detail from doxygen.
There was a problem hiding this comment.
As it seems doxygen hides namespaces named as detail by default. Shall I still add the comments then?
There was a problem hiding this comment.
Interesting, I was not aware of that. May I ask to add it anyways for consistency?
There was a problem hiding this comment.
Actually when I think about this, doxygen shouldn't hide the namespace when not specified, because my research about it didn't reveal any default hidden names.
Maybe we could also officially ignore symbols like namespaces named as detail per default:
diff --git a/cmake/templates/autodoc.doxy.in b/cmake/templates/autodoc.doxy.in
index 86861a6..1f5a011 100644
--- a/cmake/templates/autodoc.doxy.in
+++ b/cmake/templates/autodoc.doxy.in
@@ -13,4 +13,5 @@ XML_OUTPUT = @doxygen_output_file@
OUTPUT_DIRECTORY = @doxygen_output_dir@
GENERATE_LATEX = NO
INPUT = @doxygen_inputs@
+EXCLUDE_SYMBOLS = detailI could open a PR for this.
There was a problem hiding this comment.
I this does the trick, by all means, please go ahead.
There was a problem hiding this comment.
I opened the PR (#2665)
| @@ -522,6 +580,7 @@ namespace hpx { namespace util | |||
| return unwrapped(unwrapped(std::forward<Future>(f))); | |||
| } | |||
|
|
|||
| /// \copydoc unwrapped2 | |||
There was a problem hiding this comment.
This probably will not be sufficient to make doxygen generate the docs for this function.
There was a problem hiding this comment.
I tested it and doxygen generates the documentation for the function correctly:
There was a problem hiding this comment.
Ohh cool (and how surprising ;-) )
* Also add some internal comments for improved guidance
|
@hkaiser I applied the requested changes to this PR, so it should be ready for merge. |
The documentation was kept very general so it can be easily extended with the capabilities that are introduced as part of my GSoC project.