edited documentation

This commit is contained in:
arcan1s
2014-01-29 02:42:45 +04:00
parent b8e195de85
commit 34a2c5c090
82 changed files with 602 additions and 306 deletions

View File

@ -7,28 +7,22 @@
* ----------------------------------------------------------------------------
*/
/**
* @file
* @file add_main.h
* Header of agl
* @author Evgeniy Alekseev (arcanis)
* @copyright Beerware
* @bug No known bugs
*/
#ifndef ADD_MAIN_H
#define ADD_MAIN_H
/**
* @file
*/
#include <stdio.h>
#include <mathmech/messages.h>
#include <mathmech/var_types.h>
/**
* @fn error_checking
*/
int error_checking (const char *aglinp, const system_info _system_info,
const char *input, const char *output);
/**
* @brief function that checks errors in input variables
* @code
@ -46,13 +40,10 @@ int error_checking (const char *aglinp, const system_info _system_info,
* @return 14 - error in 'aglinp'
* @return 0 - exit without errors
*/
int error_checking (const char *aglinp, const system_info _system_info,
const char *input, const char *output);
/**
* @fn print_message
*/
int print_message (const int quiet, FILE *std_output, const int log, FILE *f_log,
const int mode, const char *str);
/**
* @brief function that prints message in log and stdout
* @code
@ -68,13 +59,10 @@ int print_message (const int quiet, FILE *std_output, const int log, FILE *f_log
*
* @return 0 - exit without errors
*/
int print_message (const int quiet, FILE *std_output, const int log, FILE *f_log,
const int mode, const char *str);
/**
* @fn set_defaults
*/
int set_defaults (char *aglinp, system_info *_system_info, char *input, int *log, char *output,
int *quiet);
/**
* @brief function that sets default values of variables
* @code
@ -90,6 +78,8 @@ int set_defaults (char *aglinp, system_info *_system_info, char *input, int *log
*
* @return 0 - exit without errors
*/
int set_defaults (char *aglinp, system_info *_system_info, char *input, int *log, char *output,
int *quiet);
#endif /* ADD_MAIN_H */