Closed leezu closed 4 years ago
This is a welcoming change. Thanks, @leezu. Could you share the warnings for paramdoc?
2020-03-09T23:21:05.4593612Z + cat log.txt
2020-03-09T23:21:05.4599014Z + grep -v ENABLE_PREPROCESSING
2020-03-09T23:21:05.4607401Z + grep -v 'unsupported tag'
2020-03-09T23:21:05.4610517Z + grep warning
2020-03-09T23:21:05.4631031Z /home/runner/work/dmlc-core/dmlc-core/include/dmlc/common.h:37: warning: parameters of member dmlc::HashCombine are not (all) documented
2020-03-09T23:21:05.4631961Z /home/runner/work/dmlc-core/dmlc-core/include/dmlc/common.h:37: warning: return type of member dmlc::HashCombine is not documented
2020-03-09T23:21:05.4632816Z /home/runner/work/dmlc-core/dmlc-core/include/dmlc/common.h:46: warning: parameters of member dmlc::HashCombine< size_t > are not (all) documented
2020-03-09T23:21:05.4633659Z /home/runner/work/dmlc-core/dmlc-core/include/dmlc/common.h:46: warning: return type of member dmlc::HashCombine< size_t > is not documented
2020-03-09T23:21:05.4634588Z + exit 1
2020-03-09T23:21:05.4635264Z /home/runner/work/dmlc-core/dmlc-core/include/dmlc/timer.h:27: warning: return type of member dmlc::GetTime is not documented
2020-03-09T23:21:05.4636347Z /home/runner/work/dmlc-core/dmlc-core/include/dmlc/common.h:37: warning: parameters of member dmlc::HashCombine are not (all) documented
2020-03-09T23:21:05.4637159Z /home/runner/work/dmlc-core/dmlc-core/include/dmlc/common.h:37: warning: return type of member dmlc::HashCombine is not documented
2020-03-09T23:21:05.4638617Z /home/runner/work/dmlc-core/dmlc-core/include/dmlc/common.h:46: warning: parameters of member dmlc::HashCombine< size_t > are not (all) documented
2020-03-09T23:21:05.4639580Z /home/runner/work/dmlc-core/dmlc-core/include/dmlc/common.h:46: warning: return type of member dmlc::HashCombine< size_t > is not documented
2020-03-09T23:21:05.4640771Z /home/runner/work/dmlc-core/dmlc-core/include/dmlc/timer.h:27: warning: return type of member dmlc::GetTime is not documented
2020-03-09T23:21:05.4641862Z /home/runner/work/dmlc-core/dmlc-core/include/dmlc/config.h:126: warning: parameters of member dmlc::Config::ConfigIterator::ConfigIterator are not (all) documented
2020-03-09T23:21:05.4642768Z /home/runner/work/dmlc-core/dmlc-core/include/dmlc/config.h:152: warning: return type of member dmlc::Config::ConfigIterator::operator* is not documented
2020-03-09T23:21:05.4643593Z /home/runner/work/dmlc-core/dmlc-core/include/dmlc/config.h:121: warning: parameters of member dmlc::Config::ConfigIterator::Config are not (all) documented
2020-03-09T23:21:05.4644393Z /home/runner/work/dmlc-core/dmlc-core/include/dmlc/data.h:63: warning: return type of member dmlc::DataIter::Next is not documented
2020-03-09T23:21:05.4651303Z /home/runner/work/dmlc-core/dmlc-core/include/dmlc/data.h:65: warning: return type of member dmlc::DataIter::Value is not documented
2020-03-09T23:21:05.4652260Z /home/runner/work/dmlc-core/dmlc-core/include/dmlc/io.h:174: warning: return type of member dmlc::InputSplit::GetTotalSize is not documented
2020-03-09T23:21:05.4653176Z /home/runner/work/dmlc-core/dmlc-core/include/dmlc/input_split_shuffle.h:37: warning: return type of member dmlc::InputSplitShuffle::GetTotalSize is not documented
2020-03-09T23:21:05.4654268Z /home/runner/work/dmlc-core/dmlc-core/include/dmlc/lua.h:159: warning: parameters of member dmlc::LuaRef::Handler< LuaRef > are not (all) documented
2020-03-09T23:21:05.4655088Z /home/runner/work/dmlc-core/dmlc-core/include/dmlc/lua.h:164: warning: parameters of member dmlc::LuaRef::LuaState are not (all) documented
2020-03-09T23:21:05.4655898Z /home/runner/work/dmlc-core/dmlc-core/include/dmlc/lua.h:165: warning: parameters of member dmlc::LuaRef::operator<< are not (all) documented
2020-03-09T23:21:05.4656704Z /home/runner/work/dmlc-core/dmlc-core/include/dmlc/lua.h:270: warning: parameters of member dmlc::LuaState::LuaRef are not (all) documented
2020-03-09T23:21:05.4657799Z /home/runner/work/dmlc-core/dmlc-core/include/dmlc/lua.h:270: warning: parameters of member dmlc::LuaState::ThreadLocalStore< LuaState > are not (all) documented
2020-03-09T23:21:05.4658547Z /home/runner/work/dmlc-core/dmlc-core/include/dmlc/memory_io.h:46: warning: parameters of member dmlc::MemoryFixedSizeStream::Seek are not (all) documented
2020-03-09T23:21:05.4659206Z /home/runner/work/dmlc-core/dmlc-core/include/dmlc/memory_io.h:49: warning: return type of member dmlc::MemoryFixedSizeStream::Tell is not documented
2020-03-09T23:21:05.4659845Z /home/runner/work/dmlc-core/dmlc-core/include/dmlc/memory_io.h:91: warning: parameters of member dmlc::MemoryStringStream::Seek are not (all) documented
2020-03-09T23:21:05.4660471Z /home/runner/work/dmlc-core/dmlc-core/include/dmlc/memory_io.h:94: warning: return type of member dmlc::MemoryStringStream::Tell is not documented
2020-03-09T23:21:05.4661093Z /home/runner/work/dmlc-core/dmlc-core/include/dmlc/optional.h:25: warning: parameters of member dmlc::nullopt_t::nullopt_t are not (all) documented
2020-03-09T23:21:05.4661719Z /home/runner/work/dmlc-core/dmlc-core/include/dmlc/optional.h:28: warning: parameters of member dmlc::nullopt_t::nullopt_t are not (all) documented
2020-03-09T23:21:05.4662342Z /home/runner/work/dmlc-core/dmlc-core/include/dmlc/common.h:65: warning: parameters of member dmlc::OMPException::Run are not (all) documented
2020-03-09T23:21:05.4662958Z /home/runner/work/dmlc-core/dmlc-core/include/dmlc/optional.h:48: warning: parameters of member dmlc::optional::optional are not (all) documented
2020-03-09T23:21:05.4663574Z /home/runner/work/dmlc-core/dmlc-core/include/dmlc/optional.h:58: warning: parameters of member dmlc::optional::optional are not (all) documented
2020-03-09T23:21:05.4664179Z /home/runner/work/dmlc-core/dmlc-core/include/dmlc/optional.h:76: warning: parameters of member dmlc::optional::swap are not (all) documented
2020-03-09T23:21:05.4664799Z /home/runner/work/dmlc-core/dmlc-core/include/dmlc/optional.h:99: warning: return type of member dmlc::optional::operator= is not documented
2020-03-09T23:21:05.4665569Z /home/runner/work/dmlc-core/dmlc-core/include/dmlc/optional.h:104: warning: return type of member dmlc::optional::operator* is not documented
2020-03-09T23:21:05.4666260Z /home/runner/work/dmlc-core/dmlc-core/include/dmlc/optional.h:108: warning: return type of member dmlc::optional::operator* is not documented
2020-03-09T23:21:05.4666887Z /home/runner/work/dmlc-core/dmlc-core/include/dmlc/optional.h:112: warning: parameters of member dmlc::optional::operator== are not (all) documented
2020-03-09T23:21:05.4667514Z /home/runner/work/dmlc-core/dmlc-core/include/dmlc/optional.h:112: warning: return type of member dmlc::optional::operator== is not documented
2020-03-09T23:21:05.4668124Z /home/runner/work/dmlc-core/dmlc-core/include/dmlc/optional.h:119: warning: return type of member dmlc::optional::value is not documented
2020-03-09T23:21:05.4668735Z /home/runner/work/dmlc-core/dmlc-core/include/dmlc/optional.h:128: warning: return type of member dmlc::optional::has_value is not documented
2020-03-09T23:21:05.4669374Z /home/runner/work/dmlc-core/dmlc-core/include/dmlc/data.h:63: warning: return type of member dmlc::DataIter< RowBlock< IndexType, DType > >::Next is not documented
2020-03-09T23:21:05.4670156Z /home/runner/work/dmlc-core/dmlc-core/include/dmlc/data.h:65: warning: return type of member dmlc::DataIter< RowBlock< IndexType, DType > >::Value is not documented
2020-03-09T23:21:05.4670791Z /home/runner/work/dmlc-core/dmlc-core/include/dmlc/recordio.h:138: warning: parameters of member dmlc::RecordIOReader::Seek are not (all) documented
2020-03-09T23:21:05.4671413Z /home/runner/work/dmlc-core/dmlc-core/include/dmlc/recordio.h:144: warning: return type of member dmlc::RecordIOReader::Tell is not documented
2020-03-09T23:21:05.4672028Z /home/runner/work/dmlc-core/dmlc-core/include/dmlc/recordio.h:102: warning: return type of member dmlc::RecordIOWriter::Tell is not documented
2020-03-09T23:21:05.4672674Z /home/runner/work/dmlc-core/dmlc-core/include/dmlc/data.h:63: warning: return type of member dmlc::DataIter< RowBlock< IndexType, DType > >::Next is not documented
2020-03-09T23:21:05.4673321Z /home/runner/work/dmlc-core/dmlc-core/include/dmlc/data.h:65: warning: return type of member dmlc::DataIter< RowBlock< IndexType, DType > >::Value is not documented
2020-03-09T23:21:05.4673972Z /home/runner/work/dmlc-core/dmlc-core/include/dmlc/threadediter.h:49: warning: parameters of member dmlc::ScopedThread::ScopedThread are not (all) documented
2020-03-09T23:21:05.4674601Z /home/runner/work/dmlc-core/dmlc-core/include/dmlc/threadediter.h:50: warning: parameters of member dmlc::ScopedThread::operator= are not (all) documented
2020-03-09T23:21:05.4675219Z /home/runner/work/dmlc-core/dmlc-core/include/dmlc/io.h:114: warning: parameters of member dmlc::SeekStream::Seek are not (all) documented
2020-03-09T23:21:05.4675823Z /home/runner/work/dmlc-core/dmlc-core/include/dmlc/io.h:116: warning: return type of member dmlc::SeekStream::Tell is not documented
2020-03-09T23:21:05.4676456Z /home/runner/work/dmlc-core/dmlc-core/include/dmlc/threadediter.h:202: warning: return type of member dmlc::ThreadedIter::Value is not documented
2020-03-09T23:21:05.4677101Z /home/runner/work/dmlc-core/dmlc-core/include/dmlc/memory.h:188: warning: parameters of member dmlc::ThreadlocalSharedPtr::operator== are not (all) documented
2020-03-09T23:21:05.4677733Z /home/runner/work/dmlc-core/dmlc-core/include/dmlc/memory.h:188: warning: return type of member dmlc::ThreadlocalSharedPtr::operator== is not documented
2020-03-09T23:21:05.4678344Z /home/runner/work/dmlc-core/dmlc-core/include/dmlc/io.h:539: warning: parameters of member dmlc::io::URI::URI are not (all) documented
2020-03-09T23:21:05.4678942Z /home/runner/work/dmlc-core/dmlc-core/include/dmlc/io.h:556: warning: return type of member dmlc::io::URI::str is not documented
2020-03-09T23:21:05.4681497Z ##[error]Process completed with exit code 1.
For reference, the github actions status associated with the commit: https://github.com/leezu/dmlc-core/actions/runs/52682532
Will show up in the PRs, after this PR is merged.
OK. I will merge this PR as an exception. Let's track the doc problem in the above issue.
Test on macos-10.15 and ubuntu-18.04. No change in compiler versions used. Keeps Windows tests at Appveyor, as Github Actions only provides Visual Studio 2019 and Appveyor currently tests versions going back to 2013.
We can consolidate the tests easily if the community decides to only test Visual Studio 2019.
Other fixes
WARN_NO_PARAMDOC=OFF
in doxygen, as current documentation fails to build if the setting is On. Many of the types in dmlc-core do not document their parameters.