Add doxygen #42
Add doxygen #42
Conversation
yasahi-hpc
added
documentation
| file(MAKE_DIRECTORY ${DOXYGEN_OUTPUT_DIR}) | ||
|
|
||
| # Only regenerate Doxygen when the Doxyfile or public headers change | ||
| add_custom_command(OUTPUT ${DOXYGEN_INDEX_FILE} |
There was a problem hiding this comment.
I did not notice this command. Seems simpler.
docs/Makefile
Outdated
There was a problem hiding this comment.
Why is a Makefile needed in addition to cmake?
There was a problem hiding this comment.
It is for sphinx, and in the end, we do not rely on CMake in the rtd workflow.
docs/conf.py
Outdated
| # sys.path.insert(0, os.path.abspath('.')) | ||
| import subprocess, os | ||
|
|
||
| def configureDoxyfile(input_dir, output_dir, doxyfile_in, doxyfile_out): |
There was a problem hiding this comment.
this same functionality is present in CMake, why is there a duplication?
| doxyfile_in = cwd + '/Doxyfile.in' | ||
| doxyfile_out = cwd + '/Doxyfile' | ||
| configureDoxyfile(input_dir, output_dir, doxyfile_in, doxyfile_out) | ||
| subprocess.call('pwd; ls -lat; doxygen Doxyfile; ls -lat doxygen/xml', shell=True) |
There was a problem hiding this comment.
here again I don't understand, does CMake handle Doxygen call or python?
There was a problem hiding this comment.
In the rtd workflow, only the python works. CMake is not used.
| extents_type m_in_extents, m_out_extents; | ||
|
|
||
| // Only used when transpose needed | ||
| //! Internal buffers used for transpose |
There was a problem hiding this comment.
without @{ @}, you only comment the first next variable m_in_T, not the following one m_out_T
There was a problem hiding this comment.
So, we need the comment like this?
//@{ //! Internal buffers used for transpose @}//
There was a problem hiding this comment.
not exactly, the @{ and @} should surround the variables, see https://www.doxygen.nl/manual/grouping.html
There was a problem hiding this comment.
So,
///@{
//! extents of input/output views
extents_type m_in_extents, m_out_extents;
///@}
| //! Internal buffers used for transpose | ||
| nonConstInViewType m_in_T; | ||
| nonConstOutViewType m_out_T; |
There was a problem hiding this comment.
| //! Internal buffers used for transpose | |
| nonConstInViewType m_in_T; | |
| nonConstOutViewType m_out_T; | |
| //! @{ | |
| //! Internal buffers used for transpose | |
| nonConstInViewType m_in_T; | |
| nonConstOutViewType m_out_T; | |
| //! @} |
In this PR, I have added a template for documentation with doxygen + sphinx. Workflow may be added based on this PR.