doxy: added params description on self-doc
authordberzano <dario.berzano@cern.ch>
Tue, 9 Dec 2014 13:55:39 +0000 (14:55 +0100)
committerdberzano <dario.berzano@cern.ch>
Fri, 9 Jan 2015 15:01:07 +0000 (16:01 +0100)
doxygen/thtml2doxy_clang.py

index 5486b98..7149d72 100755 (executable)
 #
 #  Usage:
 #
-#    `thtml2doxy_clang file1 [file2 [file3...]]`
+#    `thtml2doxy_clang [--stdout|-o] [-d] [--debug=DEBUG_LEVEL] file1 [file2 [file3...]]`
 #
-#  @author Dario Berzano <dario.berzano@cern.ch>
+#  Parameters:
+#
+#   - `--stdout|-o`: output all on standard output instead of writing files in place
+#   - `-d`: enable debug mode (very verbose output)
+#   - `--debug=DEBUG_LEVEL`: set debug level to one of `DEBUG`, `INFO`, `WARNING`, `ERROR`,
+#     `CRITICAL`
+#
+#  @author Dario Berzano, CERN
 #  @date 2014-12-05