[c++] Fix \param names that do not match the signatures (#7386)

Co-authored-by: darkdi <rantovov5@gmail.com>
Co-authored-by: James Lamb <jaylamb20@gmail.com>
This commit is contained in:
Dmitry
2026-08-20 06:01:51 +03:00
committed by GitHub
parent d15dea5ee9
commit a7c8976963
3 changed files with 11 additions and 8 deletions
-1
View File
@@ -37,7 +37,6 @@ class DART: public GBDT {
* \param train_data Training data
* \param objective_function Training objective function
* \param training_metrics Training metrics
* \param output_model_filename Filename of output model
*/
void Init(const Config* config, const Dataset* train_data,
const ObjectiveFunction* objective_function,
+6 -3
View File
@@ -82,8 +82,8 @@ class DataPartition {
/*!
* \brief Get the data indices of one leaf
* \param leaf index of leaf
* \param indices output data indices
* \return number of data on this leaf
* \param out_len number of data on this leaf
* \return the data indices of this leaf
*/
const data_size_t* GetIndexOnLeaf(int leaf, data_size_t* out_len) const {
// copy reference, maybe unsafe, but faster
@@ -95,8 +95,11 @@ class DataPartition {
/*!
* \brief Split the data
* \param leaf index of leaf
* \param feature_bins feature bin data
* \param dataset dataset that holds the bin data
* \param feature index of the feature to split on
* \param threshold threshold that want to split
* \param num_threshold number of "words" in the bitset for categorical features, 1 for continuous features
* \param default_left whether missing values go to the left leaf
* \param right_leaf index of right leaf
*/
void Split(int leaf, const Dataset* dataset, int feature,
+5 -4
View File
@@ -54,8 +54,9 @@ class FeatureHistogram {
/*!
* \brief Init the feature histogram
* \param feature the feature data for this histogram
* \param min_num_data_one_leaf minimal number of data in one leaf
* \param data the histogram data for this feature
* \param data_int16 the 16-bit histogram data for this feature (used for quantized training via 'use_quantized_grad')
* \param meta pointer to a FeatureMetaInfo object for this feature, with details like how missing values are handled and a pointer to the Config object with parameters
*/
void Init(hist_t* data, int16_t* data_int16, const FeatureMetainfo* meta) {
meta_ = meta;
@@ -66,8 +67,8 @@ class FeatureHistogram {
/*!
* \brief Init the feature histogram
* \param feature the feature data for this histogram
* \param min_num_data_one_leaf minimal number of data in one leaf
* \param data the histogram data for this feature
* \param meta pointer to a FeatureMetaInfo object for this feature, with details like how missing values are handled and a pointer to the Config object with parameters
*/
void Init(hist_t* data, const FeatureMetainfo* meta) {
meta_ = meta;