From e08542c6357bc044199e4876d9bea949d05f614c Mon Sep 17 00:00:00 2001 From: tqchen Date: Wed, 8 Apr 2015 15:30:56 -0700 Subject: [PATCH] fix doc --- doc/Doxyfile | 2 +- doc/mkdoc.sh | 2 +- include/dmlc/io.h | 2 ++ 3 files changed, 4 insertions(+), 2 deletions(-) diff --git a/doc/Doxyfile b/doc/Doxyfile index 2e1af0286..694bc35d3 100644 --- a/doc/Doxyfile +++ b/doc/Doxyfile @@ -95,7 +95,7 @@ WARN_LOGFILE = #--------------------------------------------------------------------------- # configuration options related to the input files #--------------------------------------------------------------------------- -INPUT = +INPUT = . dmlc INPUT_ENCODING = UTF-8 FILE_PATTERNS = RECURSIVE = NO diff --git a/doc/mkdoc.sh b/doc/mkdoc.sh index 4bc0284c3..181e280fb 100755 --- a/doc/mkdoc.sh +++ b/doc/mkdoc.sh @@ -1,4 +1,4 @@ #!/bin/bash cd ../include -doxygen ../doc/Doxyfile +doxygen ../doc/Doxyfile cd ../doc diff --git a/include/dmlc/io.h b/include/dmlc/io.h index 956ec4773..e6a6ee566 100644 --- a/include/dmlc/io.h +++ b/include/dmlc/io.h @@ -38,6 +38,7 @@ class Stream { * \param uri the uri of the input currently we support * hdfs://, s3://, and file:// by default file:// will be used * \param flag can be "w", "r", "a" + * \return a created stream */ static Stream *Create(const char *uri, const char* const flag); // helper functions to write/read different data structures @@ -115,6 +116,7 @@ class InputSplit { * \param uri the uri of the input, can contain hdfs prefix * \param part_index the part id of current input * \param num_parts total number of splits + * \return a created input split */ static InputSplit* Create(const char *uri, unsigned part_index,