Refactor, separate docs from headers, add ru docs
Doxygen kind'a sucks and I need multilanguage documentation, so I did that. Also, separated massive Math.h file into smaller files.
This commit is contained in:
@@ -24,32 +24,6 @@ typedef struct BH_ArgsOption
|
||||
typedef int (*BH_ArgsCallback)(int key, char *arg, void *data);
|
||||
|
||||
|
||||
/**
|
||||
* Parses command line \a options (given by \a argc and \a argv) and calls the
|
||||
* specified \a callback with \a data.
|
||||
*
|
||||
* There are few internal rules:
|
||||
* - If the "--" argument is specified, option parsing stops, and the rest of
|
||||
* the arguments are processed as is.
|
||||
* - If the "-" argument is specified, it is processed as is.
|
||||
* - For long options, if a value is required, the string after the equal sign
|
||||
* or the next argument will be used as the value ("--define=Value" or
|
||||
* "--define Value").
|
||||
* - For short options, if a value is required, the string after the option
|
||||
* letter or the next argument will be used as the value ("-DValue" or
|
||||
* "-D Value").
|
||||
*
|
||||
* Options array should have last element filled with zeros.
|
||||
*
|
||||
* \param argc Arguments count
|
||||
* \param argv Arguments array
|
||||
* \param options Options array pointer
|
||||
* \param callback Callback function
|
||||
* \param data Callback data
|
||||
*
|
||||
* \return On success, returns zero value.
|
||||
* \return On failure, returns error code.
|
||||
*/
|
||||
int BH_ArgsParse(int argc,
|
||||
char **argv,
|
||||
BH_ArgsOption *options,
|
||||
@@ -57,12 +31,6 @@ int BH_ArgsParse(int argc,
|
||||
void *data);
|
||||
|
||||
|
||||
/**
|
||||
* Prints documentation for \a options (with specified \a padding).
|
||||
*
|
||||
* \param options Options array pointer
|
||||
* \param padding Padding
|
||||
*/
|
||||
void BH_ArgsHelp(BH_ArgsOption *options,
|
||||
int padding);
|
||||
|
||||
|
||||
Reference in New Issue
Block a user