![]() This chain is currently called by makeqbk.py, a Python script which. It is useful for generating HTML documentation and/or an off-line reference manual from a set of documented source files. When everything is correct, give your :LGTM.Ĭongratulations, you have improved Open3D with your review. We need to create an empty Sphinx project, and add the following Python code to the Sphinx It is nothing special but asking the OS to call to generate the Doxygen documentation HTML and copy it to the Sphinx Comparing with Sphinx, Doxygen is relatively simpler to use. Boost contains currently two tools using XSLT to go from Doxygen-XML to BoostBook. Introduction to Doxygen The Doxygen package contains a documentation system for C++, C, Java, Objective-C, Corba IDL and to some extent PHP, C and D. If the PR gets frozen for a while (more than a week), ping the author to revive the process. Such strings are stored in doc and can be retrieved at runtime. Provide clear feedback to the author and make suggestions for improving the PR. For Python there is a standard way of documenting the code using so called documentation strings ('''). The src directory holds the Python source code. For SemWare's TSE Pro/32 editor Howard Kapustein has provided syntax definition files for doxygen style comment blocks. ![]() The doxygen directory holds the Doxygen configuration file (Doxyfile) along with the generated documentation. If UltraEdit is your editor of choice, take a look at Dominik Stadler's script for information on how to enable syntax highlighting for doxygen comment blocks. ![]() Verify compliance with the Open3D style guide. An example Python program, and associated module, demonstrating how to use Doxygen style comments for generating source code documentation with Doxygen. If unit tests are not provided, ask the author to add them.Ĭheck for good documentation: doxygen/docstring comments.Ĭode is simple and clear without premature optimizations. Make sure that CI is able to build the PR and that tests pass.įor features that are not covered by tests and CI (e.g., visualizer), download the code, run it, and inspect. Note that the reST is recommended by the PEP 287. You can get some information about the main formats in this blog post. However the default Sphinx docstring format was not mentioned and is based on reStructuredText (reST). When you begin the review, post a comment to indicate that you have started: e.g., “Starting to review this PR.” Python docstrings can be written following several formats as the other posts showed. Use Reviewable to perform the code review. Leave a comment on the PR mentioning your interest: e.g., “I could help review this PR.”Ī project maintainer will assign you to the PR as a reviewer. Case 3: When documenting pure Python code (no bindings)Ĭheck the list of open pull requests and pick one that doesn’t yet have a reviewer.Case 2: When documenting Python bindings.
0 Comments
Leave a Reply. |
AuthorWrite something about yourself. No need to be fancy, just an overview. ArchivesCategories |