OSDN Git Service

add doxypypy support to Subzero doxygen
authorReed Kotler <rkotlerimgtec@gmail.com>
Wed, 27 Jan 2016 03:15:50 +0000 (19:15 -0800)
committerJim Stichnoth <stichnot@chromium.org>
Wed, 27 Jan 2016 03:15:50 +0000 (19:15 -0800)
BUG=
R=stichnot@chromium.org

Review URL: https://codereview.chromium.org/1574883002 .

Patch from Reed Kotler <rkotlerimgtec@gmail.com>.

docs/Doxyfile
docs/Makefile.standalone
docs/py_filter [new file with mode: 0755]

index 0104e8e..2c666ff 100644 (file)
@@ -876,7 +876,7 @@ INPUT_FILTER           = "awk '                                                \
 # filters are used. If the FILTER_PATTERNS tag is empty or if none of the
 # patterns match the file name, INPUT_FILTER is applied.
 
-FILTER_PATTERNS        =
+FILTER_PATTERNS        = *.py=./py_filter
 
 # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
 # INPUT_FILTER ) will also be used to filter the input files that are used for
index b1094aa..7e59453 100644 (file)
@@ -1,6 +1,19 @@
 .PHONY: all
 
-all:
+all::
        mkdir -p ../build
        doxygen Doxyfile
        @echo See file://`pwd`/../build/docs/html/index.html
+
+DOXYPYPY := $(shell which doxypypy)
+
+ifeq ("$(DOXYPYPY)", "")
+all::
+       $(info Warning: ......................................)
+       $(info To get best Doxygen output for Python code, the)
+       $(info Python doxypypy package should be installed, e.g.)
+       $(info   'sudo pip install doxypypy')
+       $(info  ... or ... )
+       $(info   'easy_install doxypypy')
+       $(info see https://github.com/Feneric/doxypypy)
+endif
diff --git a/docs/py_filter b/docs/py_filter
new file mode 100755 (executable)
index 0000000..6c95593
--- /dev/null
@@ -0,0 +1,7 @@
+#!/bin/bash
+x=`which doxypypy`
+if [ "$x" == "" ]; then
+  cat $1
+else
+  doxypypy -a -c $1
+fi