mirror of
https://github.com/arcan1s/moldyn.git
synced 2025-07-18 08:10:02 +00:00
edited documentation
This commit is contained in:
@ -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 */
|
||||
|
Reference in New Issue
Block a user