plumedcheck in developer doc

developer-doc/.gitignore

@@ -4,5 +4,6 @@
 /automatic
 /*PP.txt
 /links-to-user-manual.txt
+/plumedcheck.txt
 /coverage
 

developer-doc/Doxyfile

@@ -766,7 +766,8 @@ INPUT                  = ./Intro.txt \
                          ./AddingAMeasure.txt \
                          ./AddingAMultColvar.txt \
                          ./InstallationLayout.txt \
-                         ./intro-git.txt
+                         ./intro-git.txt \
+                         ./plumedcheck.txt
 
 # This tag can be used to specify the character encoding of the source files
 # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses

developer-doc/Makefile

@@ -13,7 +13,7 @@ ifeq ($(make_doc),yes)
 endif
 
 clean:
-	rm -fr automatic html latex *~ links-to-user-manual.txt coverage coverage.info
+	rm -fr automatic html latex *~ links-to-user-manual.txt plumedcheck.txt coverage coverage.info
 
 coverage:
 	lcov -c -d ../src/ --output-file coverage.info

developer-doc/extract

@@ -36,6 +36,29 @@ awk '
   printf("%s",".html\"> "$2" </a>\n");
 }' >  links-to-user-manual.txt
 
+cat ../src/maketools/plumedcheck | grep "# DOC:" |
+{
+cat << \EOF
+// This document is formatted for Doxygen
+/**
+
+EOF
+
+awk '
+{
+  sub("# DOC:","");
+  if($0~"^ *:..*: *"){
+     print ""
+     gsub(":","_");
+     print 
+     print ""
+  } else print $0
+  
+}END{
+  printf("%s\n","*/");
+}'
+} > plumedcheck.txt
+
 
 # Create a directory to put all the files in
 #rm -rf automatic

src/maketools/plumedcheck

 #! /bin/bash
 # vim: ft=awk
 
+# DOC: \page Plumedcheck Validating syntax with plumedcheck
+# DOC: 
+# DOC: Here is a list of coding rules that are enforced by the plumedcheck script.
+# DOC: These rules are necessary to be sure that the codebase is consistent.
+# DOC: Code not satisfying these rules will make the automatic test on travis-ci fail.
+# DOC: In the following we provide a list of errors that are detected automatically,
+# DOC: together with a short explanation of the reason we consider these as errors.
+# DOC: The names used are the same ones reported by plumedcheck.
+# DOC: The `plumedcheck` script can be used as is, but the simplest way to obtain a report
+# DOC: is to go to the `buildroot/src` directory and type `make plumedcheck`.
+# DOC: In case you think you have a valid reason for a code not passing the check
+# DOC: to be merged, please contact the developers.
+
 TEMP=$(mktemp)
 
 cat > $TEMP << \EOF