Skip to content

Commit

Permalink
Fix documentation.
Browse files Browse the repository at this point in the history
  • Loading branch information
Kerilk committed May 21, 2024
1 parent 9d14e43 commit fa807c4
Show file tree
Hide file tree
Showing 6 changed files with 239 additions and 148 deletions.
346 changes: 210 additions & 136 deletions Doxyfile

Large diffs are not rendered by default.

1 change: 0 additions & 1 deletion include/cconfigspace/configuration_space.h
Original file line number Diff line number Diff line change
Expand Up @@ -237,7 +237,6 @@ ccs_configuration_space_check_configuration(
* @param[in] features an optional features to use. If NULL and a feature space
* was provided at \p configuration_space creation, the
* deafult features of the feature space will be used.
* @param[in] rng an optional rng to use
* @param[out] configuration_ret a pointer to the variable that will contain the
* returned default configuration
* @return #CCS_RESULT_SUCCESS on success
Expand Down
4 changes: 2 additions & 2 deletions include/cconfigspace/evaluation.h
Original file line number Diff line number Diff line change
Expand Up @@ -227,8 +227,8 @@ ccs_evaluation_check(ccs_evaluation_t evaluation, ccs_bool_t *is_valid_ret);
* @return #CCS_RESULT_ERROR_INVALID_OBJECT if \p evaluation or \p
* other_evaluation are not valid CCS evaluations; or if \p evaluation and \p
* other_evaluation do not share the same objective space; or if any of the
* the evaluation is associated a result code different than #CCS_RESULT_SUCESS;
* or if both evaluations are not ot the same type
* the evaluation is associated a result code different than
* #CCS_RESULT_SUCCESS; or if both evaluations are not ot the same type
* @return #CCS_RESULT_ERROR_INVALID_VALUE if \p result_ret is NULL; or if there
* was an issue evaluating any of the objectives
* @remarks
Expand Down
15 changes: 8 additions & 7 deletions include/cconfigspace/expression.h
Original file line number Diff line number Diff line change
Expand Up @@ -541,20 +541,21 @@ ccs_expression_get_parameters(
/**
* Validate that an expression can be evaluated in the given context.
* @param[in] expression
* @param[in] context the context to verify the expression can be evaluated in.
* Can be NULL
* @param[in] num_contexts the number of contexts in \p contexts
* @param[in] contexts an array of \p num_contexts contexts
* @return #CCS_RESULT_SUCCESS on success
* @return #CCS_RESULT_ERROR_INVALID_OBJECT if \p expression is not a valid CCS
* expression; or if expression depends on a parameter and \p context is not a
* expression; or if one of the provided ocntexts in \p contexts is not a
* valid CCS context
* @return #CCS_RESULT_ERROR_INVALID_VALUE if the expression depends on a
* parameter and \p context is NULL
* @return #CCS_RESULT_ERROR_INVALID_PARAMETER if \p context does not contain
* one of the parameters referenced by the expression
* parameter and \p contexts is NULL
* @return #CCS_RESULT_ERROR_INVALID_PARAMETER if one of the parameters
* referenced by the expression cannot be found in at least one the contexts in
* \p contexts
* @return #CCS_RESULT_ERROR_OUT_OF_MEMORY if there was not enough memory to
* allocate temporary storage
* @remarks
* This function is thread-safe while threads are only reading context
* This function is thread-safe
*/
extern ccs_result_t
ccs_expression_check_contexts(
Expand Down
15 changes: 15 additions & 0 deletions include/cconfigspace/feature_space.h
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,9 @@ extern "C" {
/**
* Create a new feature space.
* @param[in] name pointer to a string that will be copied internally
* @param[in] num_parameters the number of provided parameters
* @param[in] parameters an array of \p num_parameters parameters
* to add to the feature space
* @param[out] feature_space_ret a pointer to the variable that will hold
* the newly created feature space
* @return #CCS_RESULT_SUCCESS on success
Expand All @@ -37,6 +40,18 @@ ccs_create_feature_space(
ccs_parameter_t *parameters,
ccs_feature_space_t *feature_space_ret);

/**
* Get the default features of a feature space.
* @param[in] feature_space
* @param[in] features_ret a pointer to a variable that will contain the
* returned features.
* @return #CCS_RESULT_SUCCESS on success
* @return #CCS_RESULT_ERROR_INVALID_OBJECT if \p feature_space is not a valid
* CCS feature space
* @return #CCS_RESULT_ERROR_INVALID_VALUE if \p feature_space_ret is NULL
* @remarks
* This function is thread-safe
*/
extern ccs_result_t
ccs_feature_space_get_default_features(
ccs_feature_space_t feature_space,
Expand Down
6 changes: 4 additions & 2 deletions include/cconfigspace/objective_space.h
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,7 @@ typedef enum ccs_objective_type_e ccs_objective_type_t;
/**
* Create a new objective space.
* @param[in] name pointer to a string that will be copied internally
* @param[in] search_space a CCS search space
* @param[in] num_parameters the number of provided parameters
* @param[in] parameters an array of \p num_parameters parameters
* to add to the objective space
Expand All @@ -50,8 +51,9 @@ typedef enum ccs_objective_type_e ccs_objective_type_t;
* parameters is NULL; or if \p num_parameters is NULL; or if \p
* objectives is NULL and \p num_objectives is greater than 0; of if \p
* types is NULL and \p num_objectives is greater than 0
* @return #CCS_RESULT_ERROR_INVALID_OBJECT if a parameter is not a valid CCS
* parameter; or if an expressions is not a valid CCS expression
* @return #CCS_RESULT_ERROR_INVALID_OBJECT if search_space is not a valid CCS
* search space; or if a parameter is not a valid CCS parameter; or if an
* expressions is not a valid CCS expression
* @return #CCS_RESULT_ERROR_INVALID_PARAMETER if a parameter appears more than
* once in \p parameters; or if two or more parameters share the same name; or
* if a paramater is already part of another context; or if an expression
Expand Down

0 comments on commit fa807c4

Please sign in to comment.