diff --git a/agl/about.dox b/agl/about.dox deleted file mode 100644 index c294ae9..0000000 --- a/agl/about.dox +++ /dev/null @@ -1,63 +0,0 @@ -/*! - * @mainpage agl - * @image latex ./logo.png - * - * @section intro_sec Introduction - * - * About this program: - *
- *
- * agl -a FILENAME -i FILENAME -c X,Y,Z -o FILEMANE [ -l LOGFILE] [ -q ] [ -h ] - * - * Parametrs: - * -a - input file with aglomerates (in format statgen) - * -i - input file with coordinates - * -c - cell size (float), A - * -o - output file with coordinates - * -l - log enable - * -q - quiet enable - * -h - show this help and exit - *- * - * @page Install - * - * @section Requirements Requirements - * The application statgen requires the following external stuff: - * - cmake >= 2.8 - * - gcc >= 4.8 - * - * @section How-To How to install - * - * @subsection Linux Linux - * @code - * mkdir build && cd build - * cmake -DCMAKE_INSTALL_PREFIX=/usr -DCMAKE_BUILD_TYPE=Release ../ - * make - * make install - * @endcode - * - * @subsection Windows Windows - * @code - * create project file using 'cmake' - * compile project - * @endcode - * You may also download compiled executable file for Win_x86. - * - * @page Changelog - * V.1.0.1 (2013-07-27) - * * initial release - */ diff --git a/agl/src/main.c b/agl/src/main.c index 4fe65fc..98bc89e 100644 --- a/agl/src/main.c +++ b/agl/src/main.c @@ -1,6 +1,69 @@ /** * @file */ +/** + * @mainpage agl + * @image latex ./logo.png + * + * @section intro_sec Introduction + * + * About this program: + *
+ *
+ * agl -a FILENAME -i FILENAME -c X,Y,Z -o FILEMANE [ -l LOGFILE] [ -q ] [ -h ] + * + * Parametrs: + * -a - input file with aglomerates (in format statgen) + * -i - input file with coordinates + * -c - cell size (float), A + * -o - output file with coordinates + * -l - log enable + * -q - quiet enable + * -h - show this help and exit + *+ * + * @page Install + * + * @section Requirements Requirements + * The application statgen requires the following external stuff: + * - cmake >= 2.8 + * - gcc >= 4.8 + * + * @section How-To How to install + * + * @subsection Linux Linux + * @code + * mkdir build && cd build + * cmake -DCMAKE_INSTALL_PREFIX=/usr -DCMAKE_BUILD_TYPE=Release ../ + * make + * make install + * @endcode + * + * @subsection Windows Windows + * @code + * create project file using 'cmake' + * compile project + * @endcode + * You may also download compiled executable file for Win_x86. + * + * @page Changelog + * V.1.0.1 (2013-07-27) + * * initial release + */ #include
- *
- * envir -i FILENAME -c X,Y,Z -o FILEMANE [ -n NUM_OF_MOLECULE ] [ -r RADIUS ] - * [ -l LOGFILE] [ -q ] [ -h ] - * - * Parametrs: - * -i - input file with coordinates - * -c - cell size (float), A - * -o - output file with coordinates - * -n - number of molecule for search (integer). Default is 1 - * -r - radius of environment (float). Default is 6.0 - * -l - log enable - * -q - quiet enable - * -h - show this help and exit - *- * - * @page Install - * - * @section Requirements Requirements - * The application statgen requires the following external stuff: - * - cmake >= 2.8 - * - gcc >= 4.8 - * - * @section How-To How to install - * - * @subsection Linux Linux - * @code - * mkdir build && cd build - * cmake -DCMAKE_INSTALL_PREFIX=/usr -DCMAKE_BUILD_TYPE=Release ../ - * make - * make install - * @endcode - * - * @subsection Windows Windows - * @code - * create project file using 'cmake' - * compile project - * @endcode - * You may also download compiled executable file for Win_x86. - * - * @page Changelog - * V.1.0.1 (2013-07-27) - * * initial release - */ diff --git a/envir/src/main.c b/envir/src/main.c index 2520e95..a923bb7 100644 --- a/envir/src/main.c +++ b/envir/src/main.c @@ -1,6 +1,71 @@ /** * @file */ +/** + * @mainpage envir + * @image latex ./logo.png + * + * @section intro_sec Introduction + * + * About this program: + *
+ *
+ * envir -i FILENAME -c X,Y,Z -o FILEMANE [ -n NUM_OF_MOLECULE ] [ -r RADIUS ] + * [ -l LOGFILE] [ -q ] [ -h ] + * + * Parametrs: + * -i - input file with coordinates + * -c - cell size (float), A + * -o - output file with coordinates + * -n - number of molecule for search (integer). Default is 1 + * -r - radius of environment (float). Default is 6.0 + * -l - log enable + * -q - quiet enable + * -h - show this help and exit + *+ * + * @page Install + * + * @section Requirements Requirements + * The application statgen requires the following external stuff: + * - cmake >= 2.8 + * - gcc >= 4.8 + * + * @section How-To How to install + * + * @subsection Linux Linux + * @code + * mkdir build && cd build + * cmake -DCMAKE_INSTALL_PREFIX=/usr -DCMAKE_BUILD_TYPE=Release ../ + * make + * make install + * @endcode + * + * @subsection Windows Windows + * @code + * create project file using 'cmake' + * compile project + * @endcode + * You may also download compiled executable file for Win_x86. + * + * @page Changelog + * V.1.0.1 (2013-07-27) + * * initial release + */ #include
- *
- * statgen -i INPUT -s FIRST,LAST -c X,Y,Z -a ... -r ... -o OUTPUT [ -g DEPTH ] - * [ -l LOGFILE ] [ -q ] [ -h ] - * - * Parametrs: - * -i - mask of input files - * -s - trajectory steps (integer) - * -c - cell size (float), A - * -a - atom types (integer). Format: 'ATOM1' or 'ATOM1,ATOM2' or etc - * -r - criteria (float), A. Format: '0-0:2.4,0-1:3.0' means 0-0-interaction - * (<2.4 A) and 0-1 (<3.0) are needed. This flag can be used multiple times - * -o - output file name - * -g - check graph isomorphism. DEPTH is max depth for check cycles (>= 3) - * -l - log enable - * -q - quiet enable - * -h - show this help and exit - *- * - * @page Install - * - * @section Requirements Requirements - * The application statgen requires the following external stuff: - * - cmake >= 2.8 - * - gcc >= 4.8 - * - * @section How-To How to install - * - * @subsection Linux Linux - * @code - * mkdir build && cd build - * cmake -DCMAKE_INSTALL_PREFIX=/usr -DCMAKE_BUILD_TYPE=Release ../ - * make - * make install - * @endcode - * - * @subsection Windows Windows - * @code - * create project file using 'cmake' - * compile project - * @endcode - * You may also download compiled executable file for Win_x86. - * - * @page Changelog - * V.1.0.1 (2013-07-27) - * * initial release - */ diff --git a/statgen/src/main.c b/statgen/src/main.c index 47781db..3d9239c 100644 --- a/statgen/src/main.c +++ b/statgen/src/main.c @@ -1,6 +1,74 @@ /** * @file */ +/** + * @mainpage statgen + * @image latex ./logo.png + * + * @section intro_sec Introduction + * + * About this program: + *
+ *
+ * statgen -i INPUT -s FIRST,LAST -c X,Y,Z -a ... -r ... -o OUTPUT [ -g DEPTH ] + * [ -l LOGFILE ] [ -q ] [ -h ] + * + * Parametrs: + * -i - mask of input files + * -s - trajectory steps (integer) + * -c - cell size (float), A + * -a - atom types (integer). Format: 'ATOM1' or 'ATOM1,ATOM2' or etc + * -r - criteria (float), A. Format: '0-0:2.4,0-1:3.0' means 0-0-interaction + * (<2.4 A) and 0-1 (<3.0) are needed. This flag can be used multiple times + * -o - output file name + * -g - check graph isomorphism. DEPTH is max depth for check cycles (>= 3) + * -l - log enable + * -q - quiet enable + * -h - show this help and exit + *+ * + * @page Install + * + * @section Requirements Requirements + * The application statgen requires the following external stuff: + * - cmake >= 2.8 + * - gcc >= 4.8 + * + * @section How-To How to install + * + * @subsection Linux Linux + * @code + * mkdir build && cd build + * cmake -DCMAKE_INSTALL_PREFIX=/usr -DCMAKE_BUILD_TYPE=Release ../ + * make + * make install + * @endcode + * + * @subsection Windows Windows + * @code + * create project file using 'cmake' + * compile project + * @endcode + * You may also download compiled executable file for Win_x86. + * + * @page Changelog + * V.1.0.1 (2013-07-27) + * * initial release + */ #include