Doxygen API lacks classes of namespace "tvm::codegen"?

Johnson9009 · October 23, 2020, 3:29am

From the official document web page https://tvm.apache.org/docs/api/links.html, we can find the C++ doyxgen API, but in the doyxgen web page there isn’t any classes of namespace “tvm::codegen”, such as “tvm::codegen::CodeGenC”, “tvm::codegen::CodeGenCUDA”.

If user don’t have code analyzing tool like " Source Insight", “Understand”, C++ Doxygen document is very good place to browse the TVM source code, such as inheritance relationship like below figure shown.

Why there isn’t any classes of namespace “tvm::codegen”? Thanks.

Johnson9009 · October 28, 2020, 6:54am

From browsing the source code, I found that the doxygen documents are controled by “docs/Doxyfile”, from the configuration file, why only the “include/tvm” is set to “INPUT”? It seems that we only decide to generate the doxygen documents for header files now, is there some reason for that? @tqchen Thanks.

github.com

apache/incubator-tvm/blob/3d624ec07352ced5d1c6ce3b340eacc4a81457b2/docs/Doxyfile#L773


#---------------------------------------------------------------------------
# Configuration options related to the input files
#---------------------------------------------------------------------------

# The INPUT tag is used to specify the files and/or directories that contain
# documented source files. You may enter file names like myfile.cpp or
# directories like /usr/src/myproject. Separate the files or directories with
# spaces.
# Note: If this tag is empty the current directory is searched.

INPUT                  = include/tvm

# This tag can be used to specify the character encoding of the source files
# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
# libiconv (or the iconv built into libc) for the transcoding. See the libiconv
# documentation (see: http://www.gnu.org/software/libiconv) for the list of
# possible encodings.
# The default value is: UTF-8.

INPUT_ENCODING         = UTF-8