mirror of
https://github.com/arcan1s/moldyn.git
synced 2025-07-23 02:29:58 +00:00
edited documentation
This commit is contained in:
@ -7,7 +7,11 @@
|
||||
* ----------------------------------------------------------------------------
|
||||
*/
|
||||
/**
|
||||
* @file
|
||||
* @file add_main.c
|
||||
* Source code of envir
|
||||
* @author Evgeniy Alekseev (arcanis)
|
||||
* @copyright Beerware
|
||||
* @bug No known bugs
|
||||
*/
|
||||
|
||||
#include <stdio.h>
|
||||
|
@ -7,7 +7,11 @@
|
||||
* ----------------------------------------------------------------------------
|
||||
*/
|
||||
/**
|
||||
* @file
|
||||
* @file add_main.h
|
||||
* Header of envir
|
||||
* @author Evgeniy Alekseev (arcanis)
|
||||
* @copyright Beerware
|
||||
* @bug No known bugs
|
||||
*/
|
||||
|
||||
#ifndef ADD_MAIN_H
|
||||
@ -16,11 +20,6 @@
|
||||
#include <mathmech/var_types.h>
|
||||
|
||||
|
||||
/**
|
||||
* @fn error_checking
|
||||
*/
|
||||
int error_checking (const system_info _system_info, const char *input,
|
||||
const char *output);
|
||||
/**
|
||||
* @brief function that checks errors in input variables
|
||||
* @code
|
||||
@ -36,13 +35,10 @@ int error_checking (const system_info _system_info, const char *input,
|
||||
* @return 13 - error in 'output'
|
||||
* @return 0 - exit without errors
|
||||
*/
|
||||
int error_checking (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
|
||||
@ -58,13 +54,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 (system_info *_system_info, char *input, int *log, int *num_of_mol,
|
||||
char *output, int *quiet, float *rad);
|
||||
/**
|
||||
* @brief function that sets default values of variables
|
||||
* @code
|
||||
@ -82,6 +75,8 @@ int set_defaults (system_info *_system_info, char *input, int *log, int *num_of_
|
||||
*
|
||||
* @return 0 - exit without errors
|
||||
*/
|
||||
int set_defaults (system_info *_system_info, char *input, int *log, int *num_of_mol,
|
||||
char *output, int *quiet, float *rad);
|
||||
|
||||
|
||||
#endif /* ADD_MAIN_H */
|
||||
|
@ -7,7 +7,11 @@
|
||||
* ----------------------------------------------------------------------------
|
||||
*/
|
||||
/**
|
||||
* @file
|
||||
* @file main.c
|
||||
* Source code of envir
|
||||
* @author Evgeniy Alekseev (arcanis)
|
||||
* @copyright Beerware
|
||||
* @bug No known bugs
|
||||
*/
|
||||
|
||||
#include <math.h>
|
||||
|
Reference in New Issue
Block a user