[docs] fixed and enhanced format of C API #2195
Conversation
| * \brief Create an empty dataset by sampling data. | ||
| * \param sample_data Sampled data, grouped by the column |
There was a problem hiding this comment.
This lost param was the reason why #2076 ruined all C API docs.
It's quite strange, but \fn directive makes Doxygen produce xml without descriptions instead of generating the error.
Also, Doxygen's docs say that we don't need to use \fn directives when comments are placed directly before function:
Warning
Do not use this command if it is not absolutely needed, since it will lead to duplication of information and thus to errors.
http://www.doxygen.nl/manual/commands.html#cmdfn
So I removed them all.
include/LightGBM/c_api.h
Outdated
| LIGHTGBM_C_EXPORT int LGBM_DatasetCreateFromFile(const char* filename, | ||
| const char* parameters, | ||
| const DatasetHandle reference, | ||
| DatasetHandle* out); | ||
|
|
||
| /*! | ||
| * \fn LGBM_DatasetCreateFromSampledColumn | ||
| * \brief Create an empty dataset by sampling data. |
There was a problem hiding this comment.
Is it really empty?
There was a problem hiding this comment.
it will allocate the spaces, so no really empty. But the data are push afterward.
There was a problem hiding this comment.
Thanks, got it! Maybe then change it to Allocate the space for dataset by sampling data.?
There was a problem hiding this comment.
sure, BTW, it will also bucket the feature bins (construct bin_mapper) according to sample data.
There was a problem hiding this comment.
Updated. And one next function description too.
Final result: https://lightgbm.readthedocs.io/en/c_api/C-API.html.