Skip to content
Snippets Groups Projects
Commit 7ec99e6f authored by Giovanni Bussi's avatar Giovanni Bussi
Browse files

Added doc for script tools

Closes #354
parent 1f64107b
No related branches found
No related tags found
No related merge requests found
...@@ -34,7 +34,34 @@ do ...@@ -34,7 +34,34 @@ do
done done
# Generate all the documentation pages from comments # Generate all the documentation pages from comments
cat ../*/*/*cpp | {
cat ../*/*/*cpp
# documentation for scripts:
for file in ../scripts/*.sh
do
name=$(basename ${file%.sh})
cat << EOF
//+PLUMEDOC TOOLS $name
/*
EOF
../src/lib/plumed $name --description
cat << EOF
\note This command line tool is implemented as a shell script. It's help message is pasted below:
\verbatim
EOF
../src/lib/plumed --no-mpi $name --help
cat << EOF
\endverbatim
*/
//+ENDPLUMEDOC
EOF
done
} |
awk 'BEGIN{gfile="automatic/GLOSSARY.list"; dfile="automatic/DICTIONARY.list"; }{ awk 'BEGIN{gfile="automatic/GLOSSARY.list"; dfile="automatic/DICTIONARY.list"; }{
if($1=="//+ENDPLUMEDOC" && inside){ if($1=="//+ENDPLUMEDOC" && inside){
inside=0; inside=0;
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment